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

Authorization

AuthorizationRequiredBearer <token>

< Project ID >:< Management Key > as bearer

In: header

Request Body

application/jsonRequired
tenantIdsarray<string>
roleNamesarray<string>
roleNameLikestring
permissionNamesarray<string>
textstring

Full text search across relevant columns

sortarray<object>
includeProjectRolesboolean

relevant when tenantIds are set

curl -X POST "https://api.descope.com/v1/mgmt/role/search" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "tenantIds": [
      "string"
    ],
    "roleNames": [
      "string"
    ],
    "roleNameLike": "string",
    "permissionNames": [
      "string"
    ],
    "text": "string",
    "sort": [
      {
        "field": "string",
        "desc": true
      }
    ],
    "includeProjectRoles": true
  }'

OK

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

Was this helpful?

Load All Roles GET

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

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