Roles

Search roles

Search roles by name or display name. Use q parameter to provide the search query.

get/v1/roles/search

Request

  • Base URL: https://demo.getcollate.io/api
  • URL: https://demo.getcollate.io/api/v1/roles/search
  • Auth: HTTP bearer

Query parameters

qstring

Search query for role names or display names

fieldsstring
Example:policies,teams,users

Fields requested in the returned resource

limitinteger

Limit the number of roles returned. (1 to 1000, default = 10)

offsetinteger

Offset for pagination (default = 0)

include'all' | 'deleted' | 'non-deleted'

Include all, deleted, or non-deleted entities.

Response

List of matching roles

warningsCountinteger

Changes

No recorded changes to this operation across all 1 revision of this API.