Passer au contenu principal
GET
/
roles
List roles
curl --request GET \
  --url https://{tenantDomain}/my-org/v1/roles \
  --header 'Authorization: Bearer <token>'
{
  "roles": [
    {
      "id": "rol_BKI0BKI0BKI0BKI0",
      "name": "Admin",
      "description": "Administrator role with full access"
    },
    {
      "id": "rol_BKI0BKI0BKI0BKI1",
      "name": "User",
      "description": "Standard user role with limited access"
    }
  ],
  "next": "abc123"
}

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de requête

from
string

An optional cursor from which to start the selection (exclusive).

Required string length: 1 - 1000
take
integer
défaut:50

Number of results per page. Defaults to 50.

Plage requise: 1 <= x <= 100
name
string

An optional filter on the name (case-insensitive).

Required string length: 1 - 300

Réponse

Retrieve roles for the organization.

roles
object[]
requis
next
string

Pagination cursor for the next page of results