Patch
/sys/v1/users/{user_id}
Change a user's properties like first_name, last_name, description, etc.
Security
HTTP
Type bearer
API Key
Header parameter nameAuthorization
Path parameters
user_id
string (uuid) Required
Body parameters
object
account_role
Array
OneOf
string
string
Valid values[
"STATEENABLED",
"PENDINGINVITE"
]
string
string
Valid values[
"ACCOUNTADMINISTRATOR",
"ACCOUNTMEMBER",
"ACCOUNTAUDITOR"
]
string (uuid)
string
add_groups
object | null
property*
Array additionalProperties
OneOf
string
string
Valid values[
"GROUPAUDITOR",
"GROUPADMINISTRATOR"
]
string (uuid)
string
add_mfa_devices
Array of object | null
object
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
attestationResult
object Required
id
string (byte)
type
string
Valid values[
"public-key"
]
response
object
clientDataJSON
string (byte) Required
getTransports
Array
OneOf
string
string
Valid values[
"usb",
"nfc",
"ble",
"internal"
]
string
string
attestationObject
string (byte) Required
get_client_extension_results
object
appidExclude
boolean | null
appid
boolean | null
add_u2f_devices
Array of object | null
object
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
registrationData
string (byte) Required
clientData
string (byte) Required
version
string Required
del_groups
object | null
property*
Array additionalProperties
OneOf
string
string
Valid values[
"GROUPAUDITOR",
"GROUPADMINISTRATOR"
]
string (uuid)
string
del_mfa_devices
Array of object | null
object
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
del_u2f_devices
Array of object | null
object
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
description
string | null
enable
boolean | null
first_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
last_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
mod_groups
object | null
property*
Array additionalProperties
OneOf
string
string
Valid values[
"GROUPAUDITOR",
"GROUPADMINISTRATOR"
]
string (uuid)
string
rename_mfa_devices
Array of object | null
object
old_name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
new_name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
rename_u2f_devices
Array of object | null
object
old_name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
new_name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
user_email
string (email)
user_password
string
Responses
2XX
Success result
object
account_role
Array
OneOf
string
string
Valid values[
"STATEENABLED",
"PENDINGINVITE"
]
string
string
Valid values[
"ACCOUNTADMINISTRATOR",
"ACCOUNTMEMBER",
"ACCOUNTAUDITOR"
]
string (uuid)
string
created_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
dependent_services
Array of string | null
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
description
string | null
email_verified
boolean | null
explicit_groups
object
property*
Array additionalProperties
OneOf
string
string
Valid values[
"GROUPAUDITOR",
"GROUPADMINISTRATOR"
]
string (uuid)
string
first_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
groups
object
property*
Array additionalProperties
OneOf
string
string
Valid values[
"GROUPAUDITOR",
"GROUPADMINISTRATOR"
]
string (uuid)
string
has_account
boolean | null
has_password
boolean | null
last_logged_in_at
string
Pattern^\d{4}\d{2}\d{2}T\d{2}\d{2}\d{2}Z$
last_name
string | null
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
mfa_devices
Array of object (MfaDevice)
object
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
type
string
Valid values[
"U2f",
"Fido2"
]
origin
string | null
new_email
string (email)
self_provisioned
boolean | null
u2f_devices
Array of object (MfaDevice)
object
name
string
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
type
string
Valid values[
"U2f",
"Fido2"
]
origin
string | null
user_email
string (email)
user_id
string (uuid)