See api-docs Menu

List Roles

Use this API to return a list of roles.

Pagination is supported on this endpoint.







Resource URL

https://<api-domain>/api/2/roles

Header Parameters

Authorization

required

string

Set to bearer <access_token>.

Set <access_token> to the access token you generated using the Generate Token API.

The access token must have been generated using an API credential pair created using the scope required to call this API. This API can be called using any one of the following scopes: Manage All, Read All.

Query Parameters

Query Parameters

Standard pagination is supported. Max page limit is 1000. See Pagination for detail on how this works.

name

string

Optional. Filters by role name.

app_id

integer

Optional. Returns roles that contain this app ID.

app_name

string

Optional. Returns roles that contain this app name.

fields

string

Optional. Comma delimited list of fields to return.

Valid options are apps, usersadmins.

Sample Responses

[
  {
      "id": 123,
      "name": "Sample Role",
      "apps": [ 123, 456,...]
  }    
  ...
]

Typically, this error means that your access token value is invalid.

{
    "message": "Unauthorized",
    "statusCode": 401,
    "name": "UnauthorizedError"
}

Postman Collection

Replace sample variables indicated by {{ }} with your actual values.

Download for Roles API

Sample Code

cURL

Replace sample values indicated by < > with your actual values.

List Mappings

curl 'https://<api-domain>/api/2/roles' \
-X GET \
-H "Authorization: bearer <access_token>"

Have a Question?

Found a bug? Submit a support ticket.

Have a product idea or request? Share it with us in our Ideas Portal.