Get a role's groups

Lists the groups to which the specified role is assigned.

GET https://{tenantDomain}/api/v2/roles/{id}/groups

Get a role's groups

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/roles/{id}/groups \
  --header 'Authorization: Bearer <token>'

200

{
  "groups": [
    {
      "id": "<string>",
      "name": "<string>",
      "external_id": "<string>",
      "connection_id": "<string>",
      "tenant_name": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "next": "<string>"
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · string · required

Unique identifier for the role (service-generated).

Query Parameters

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 50.

Required range: x >= 1

Response

200

application/json

Role's groups successfully retrieved.

groups · object[] · required

Show child attributes

next · string

A cursor to be used as the "from" query parameter for the next page of results.