Sign in

v1

latestOpenAPI 3.0.32026-07-24148824715.6 KB
IAM

Get list of roles

Returns a list of roles. You need the View roles in organization permission to use the account_identifier parameter.

You need the "View roles in account" permission to use this endpoint.

get/v2/iam/roles

Query parameters

name_containsstring

Filter roles by name.

permissionsstring[]

Filter only roles that have all of at least one set of permissions.

[
  "1+2+5"
]
account_identifierstring uuid

The identifier of the account whose roles you'd like to retrieve.

page_numberinteger

The page of results returned within the response.

page_sizeinteger

The amount of results returned within the response.

sortstring[]

Sorting criteria in the format of: [-]property (- descending modifier).

  • Default sort order is ascending (without -).

  • Multiple sort criteria are supported.

Response

OK

firststring required

The URL path to the first page.

nextstring nullable

The URL path to the next page.

prevstring nullable

The URL path to the previous page.

selfstring required

The URL path to the current page.

total_countinteger nullable

Total number of items.

Example response

{
  "first": "/v1/resource?page_number=1",
  "next": "/v1/resource?page_number=4",
  "prev": "/v1/resource?page_number=2",
  "roles": [
    {
      "description": "View Cases",
      "identifier": "00000000-0000-0000-0000-000000000000",
      "name": "Supervisor",
      "users_assigned_count": 1
    }
  ],
  "self": "/v1/resource?page_number=3",
  "total_count": 60
}