API ReferenceManagementRoles
POST
/v1/mgmt/role/update

Update an existing role, using a valid management key.

This API endpoint allows administrators to update an existing role. The endpoint takes the following four parameters:

  • name (required)
  • newName (required)
  • description (optional - though if not provided, it will be removed from the role))
  • permissionNames (optional - though if not provided, it will be removed from the role))

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/role/update

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

namestring

newNamestring

descriptionstring

permissionNamesarray<string>

tenantIdstring

Status codeDescription
200OK
curl -X POST "https://api.descope.com/v1/mgmt/role/update" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>" \
  -d '{
  "name": "string",
  "newName": "string",
  "description": "string",
  "permissionNames": [
    "string"
  ],
  "tenantId": "string"
}'

{
  "name": "string",
  "description": "string",
  "permissionNames": [
    "string"
  ],
  "createdTime": 0,
  "tenantId": "string"
}

Was this helpful?

Previous

Create Role

Next

Delete Role