API Reference/Management/Roles
POST
/v1/mgmt/role/update

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
namestring
newNamestring
descriptionstring
permissionNamesarray<string>
tenantIdstring
curl -X POST "https://api.descope.com/v1/mgmt/role/update" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "string",
    "newName": "string",
    "description": "string",
    "permissionNames": [
      "string"
    ],
    "tenantId": "string"
  }'

OK

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

Was this helpful?

Create Role POST

### Create a role, using a valid management key. This API endpoint allows administrators to create a new role. The endpoint takes the following three parameters: - name (required) - description (optional) - permissionNames (optional) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions. ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`

Delete Role POST

### Delete a role, using a valid management key. This API endpoint allows administrators to delete an existing role. The endpoint takes the following one parameter: - name (required) ### See also - See [User Authorization](/manage/roles/) for further details on managing roles and permissions._override/App.tsx ### Endpoint Authentication Use authorization bearer header with the following format: `Authorization: Bearer <ProjectId:ManagementKey>`