API ReferenceManagementRoles
GET
/v1/mgmt/role/all

Load all roles, using a valid management key.

This API endpoint allows administrators to load all existing roles.

This endpoint returns an array of roles including their name, description, and permissionsNames.

See also

Endpoint Authentication

Use authorization bearer header with the following format:

Authorization: Bearer \<ProjectId:ManagementKey\>

Try it

/v1/mgmt/role/all

The Authorization access token

Authorization

Authorization
Required
Bearer <token>

< Project ID >:< Management Key > as bearer

In: header

Status codeDescription
200OK
curl -X GET "https://api.descope.com/v1/mgmt/role/all" \
  -H "Authorization: Bearer <ProjectId:ManagementKey>"

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

Was this helpful?

Previous

Role Management API Overview

Next

Search Roles