Roles
Community
Enterprise

List Roles

Changed on

List all authorization roles.

get/api/v2/roles

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v2/roles
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization and API key in header RequestDate and API key in header Signature

Query parameters

sort_bystring

Sort by column. Can be used multiple times; prepend a hyphen for descending order. See parameter description for details about which columns are sortable.

Sortable columns are name, description, id, created_at, updated_at.

namestring

Filter results by column string value. Valid filter predicates are eq, ~eq, neq.

idstring

Filter results by column integer value. Valid filter predicates are eq, neq, gt, gte, lt, lte.

created_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by created_at value. See filter schema details for valid predicates.

updated_atstring

Filter results by column timestamp value formatted as an RFC-3339 string. Valid filter predicates are eq, neq, gt, gte, lt, lte.

Filter results by updated_at value. See filter schema details for valid predicates.

Response

OK

Changes

  • bad196650496Revision changes
    • warning

      deleted the query request parameter deleted_at

  • 40bf219eced6Revision changes
    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?-?[0-9]+$ to the query request parameter id

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter created_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter deleted_at

    • breaking

      added the pattern ^((eq|neq|gt|gte|lt|lte):)?[0-9]{4}-[0-9]{2}-[0-9]{2}[Tt][0-9]{2}:[0-9]{2}:[0-9]{2}(\.[0-9]{1,9})?([Zz]|-[0-9]{2}:[0-9]{2})$ to the query request parameter updated_at

    • breaking

      added the pattern ^((eq|~eq|neq):)?[^:]+$ to the query request parameter name

    • info

      for the query request parameter created_at, the format was generalized from date-time to no format

    • info

      for the query request parameter deleted_at, the format was generalized from date-time to no format

    • info

      for the query request parameter id, the type was generalized from integer to string

    • info

      for the query request parameter updated_at, the format was generalized from date-time to no format