Patch
/v1/users/{user-id}
Update status, name, and the role of a user. User with MANAGER access role can only update another users.
Security
API Key: bearerToken
Header parameter nameAuthentication
A JWT bearer token to be passed once authenticated.
Path parameters
user-id
string (uuid) Required
UUID of a user.
Body parameters
object
first_name
string
First name.
last_name
string
Last name.
roles
Array of string (AccessRoles)
string
Roles of a user.
Valid values[
"READER",
"WRITER",
"MANAGER"
]
user_account_status
string
Status of an Account for a user.
Valid values[
"ACTIVE",
"PENDING",
"DISABLED"
]
user_email
string
User's new email address.
Responses
200
Updated User status, name, and role.
object
user_id
string (uuid)
User Id.
first_name
string
First Name.
last_name
string
Last Name.
user_email
string
User Email.
last_logged_in_at
integer (int64)
Last login time of user.
created_at
integer (int64)
Creation time of user.
email_verified
boolean
Whether this user's email has been verified.
status
string
Status of a user.
Valid values[
"ACTIVE",
"PENDING",
"DISABLED"
]
roles
Array of string (AccessRoles)
string
Roles of a user.
Valid values[
"READER",
"WRITER",
"MANAGER"
]
user_account_status
string
Status of an Account for a user.
Valid values[
"ACTIVE",
"PENDING",
"DISABLED"
]
accepted_latest_terms_and_conditions
boolean
Whether this user has accepted latest terms and conditions or not.
new_email
string
User’s new email address before it has been confirmed.