API ReferenceManagementUsers
POST
/v1/mgmt/user/update/name

Updates an existing user's display name, using a valid management key.

This API endpoint allows you to update the user's display name granularly without updating all user details.

The response returns the user's details in json format.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/user/update/name

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

loginIdstring

namestring

givenNamestring

middleNamestring

familyNamestring

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/user/update/name" \
  -d '{
  "loginId": "string",
  "name": "string",
  "givenName": "string",
  "middleName": "string",
  "familyName": "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

Update User Phone

Next

Update User Picture