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

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

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

OK

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

Was this helpful?

Search Roles POST

### Search roles, using a valid management key. This API endpoint allows administrators to search against existing roles. This endpoint returns an array of roles including their name, description, and permissionsNames that match the search parameters. ### 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>`

Update Role POST

### 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 - 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>`