API ReferenceManagementUsers
POST
/v1/mgmt/user/update

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\>

Try it

/v1/mgmt/user/update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

loginIdstring

emailstring

phonestring

verifiedEmailboolean

verifiedPhoneboolean

namestring

roleNamesarray<string>

userTenantsarray<object>

customAttributesobject

custom attributes of users

picturestring

additionalIdentifiersarray<string>

givenNamestring

middleNamestring

familyNamestring

ssoAppIdsarray<string>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/user/update" \
  -d '{
  "loginId": "string",
  "email": "string",
  "phone": "string",
  "verifiedEmail": true,
  "verifiedPhone": true,
  "name": "string",
  "roleNames": [
    "string"
  ],
  "userTenants": [
    {
      "tenantId": "string",
      "roleNames": [
        "string"
      ]
    }
  ],
  "customAttributes": {},
  "picture": "string",
  "additionalIdentifiers": [
    "string"
  ],
  "givenName": "string",
  "middleName": "string",
  "familyName": "string",
  "ssoAppIds": [
    "string"
  ]
}'

{
  "user": {
    "loginIds": [
      "string"
    ],
    "userId": "string",
    "name": "string",
    "email": "string",
    "phone": "string",
    "verifiedEmail": true,
    "verifiedPhone": true,
    "roleNames": [
      "string"
    ],
    "userTenants": [
      {
        "tenantId": "string",
        "roleNames": [
          "string"
        ],
        "tenantName": "string"
      }
    ],
    "status": "string",
    "externalIds": [
      "string"
    ],
    "picture": "string",
    "test": false,
    "customAttributes": {},
    "createdTime": 0,
    "TOTP": false,
    "SAML": false,
    "OAuth": {
      "property1": false,
      "property2": false
    },
    "webauthn": true,
    "password": true,
    "ssoAppIds": [
      "string"
    ],
    "givenName": "string",
    "middleName": "string",
    "familyName": "string",
    "editable": true
  }
}

Was this helpful?

Previous

Patch User

Next

Update User Status