Update User

Updates a user's details, using a valid management key.

This API endpoint will update a user's details of a user utilizing a valid management key.

It is important to understand the update will take the configurations for the user provided and will overwrite all user settings. This means that if the user currently has email and phone, but the update only includes email, the phone and other non-provided configurations will be removed.

This API endpoint will remove any details that are not provided. It is preferred to use other updates supported by the API, such as the following options:

Additionally, you can update a user with multiple login IDs by passing an array of loginIds in string format within the additionalIdentifiers key.

It is suggested to gather the current user configurations via Load User in order to assist you in building the payload for this api endpoint.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer <ProjectId:ManagementKey>

SecurityAuthProjectIdMgmtKey
Request
Request Body schema: application/json
required
loginId
string
email
string
phone
string
verifiedEmail
boolean
verifiedPhone
boolean
name
string
roleNames
Array of strings
Array of objects (managementv1.AssociatedTenant)
customAttributes
object

custom attributes of users

picture
string
additionalIdentifiers
Array of strings
givenName
string
middleName
string
familyName
string
ssoAppIds
Array of strings
Responses
200

OK

post/v1/mgmt/user/update
Request samples 
Response samples 
application/json
{
  • "user": {
    }
}