v1

latestOpenAPI 3.0.02026-08-064311,0881.3 MB

roleManagement

Get a list of roles.

Get a list of all the roles in the organization. The response is paginated with a default limit of 100 roles per page.

get/v1/roles

Query parameters

limitinteger

Limit the number of roles returned in the response. The number of roles returned may be less than the limit.

tokenstring

Continuation token to get the next page of results. A page object with the next continuation token is returned in the response body. Subsequent GET requests should specify the continuation token to get the next page of results. token is set to null when no more pages are left.

sortBystring

Sort the list of roles by the name field.

namestring

Only return roles matching the given name.

Response

A paginated list of roles in the organization.

nextstring

Next continuation token.

Example response

{
  "data": [
    {
      "name": "DataAdmin",
      "description": "Manage data of the org.",
      "filterPredicate": "!_sourceCategory=billing",
      "users": [
        "0000000006743FE0",
        "0000000005FCE0EE"
      ],
      "capabilities": [
        "manageContent",
        "manageDataVolumeFeed",
        "manageFieldExtractionRules",
        "manageS3DataForwarding"
      ],
      "createdAt": "2018-10-16T09:10:00Z",
      "createdBy": "0000000006743FDD",
      "modifiedAt": "2018-10-16T09:10:00Z",
      "modifiedBy": "0000000006743FE8",
      "id": "0000000000E20FE3"
    }
  ],
  "next": "GDCiRv4vebF3UWFJQ1kySXBOR3Bzh69GR0RyWm9vCtc"
}