API DocsRESTRole service

ListRoles

Retrieves roles using an optional filter.

GET
/api/v2/roles

Query Parameters

pageSizeinteger

The maximum number of roles to return. The service may return fewer than this value. If unspecified, at most 50 roles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

Format: "int64"

pageTokenstring

A page token, received from a previous ListRoles call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ListRoles must match the call that provided the page token.

filterstring

A Common Expression Language (CEL) filter string. Available fields to filter by are role_id, name, and description. For further information about how to use CELs, please refer to this guide. For more information about the fields used for filtering, please refer to this definition. Optional.

orderBystring

How to order the retrieved channels. Formatted as a comma-separated string i.e. "FIELD_NAME[ desc],...". Available fields to order_by are name and description. If left empty, items are ordered by name in ascending order (oldest-first). For more information about the format of this field, read this Example: "name desc,description"

curl -X GET "<API_URL>/api/v2/roles?pageSize=0&pageToken=string&filter=string&orderBy=string" \
  -H "Authorization: Bearer <API_KEY>"

A successful response.

{
  "roles": [
    {
      "roleId": "string",
      "name": "string",
      "description": "string"
    }
  ],
  "nextPageToken": "string"
}

Previous

UpdateReportTemplate PATCH

Next

EvaluateRules POST