API ReferenceManagementUsers
POST
/v2/mgmt/user/update/role/add

Add roles to an existing user, using a valid management key.

This API endpoint allows you to add roles to a user granularly without updating all user details.

roleNames is an array of the role names in string format.

The tenantId is optional; if provided, the user must be a member of that tenant

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

/v2/mgmt/user/update/role/add

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

loginIdstring

tenantIdstring

roleNamesarray<string>

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v2/mgmt/user/update/role/add" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "loginId": "string",
  "tenantId": "string",
  "roleNames": [
    "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 Remove Tenant

Next

Set User's Roles