POST
/v1/mgmt/role/update

Authorization

Descope Project ID and Management Key
AuthorizationBearer <token>

Project ID:Management Key as bearer token.

In: header

Request Body

application/json

name?string

Either name or id must be provided (not both). The identified role will be updated.

newName?string
description?string
permissionNames?array<string>
string
tenantId?string
default?boolean
private?boolean
id?string

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

curl -X POST "https://api.descope.com/v1/mgmt/role/update" \  -H "Content-Type: application/json" \  -d '{}'
{  "name": "string",  "description": "string",  "permissionNames": [    "string"  ],  "createdTime": 0,  "tenantId": "string",  "default": true,  "private": true,  "id": "string"}
export interface Response {name?: stringdescription?: stringpermissionNames?: string[]createdTime?: numbertenantId?: stringdefault?: booleanprivate?: booleanid?: string}
Was this helpful?