roles

Requires at least one of the permissions settings:role:list, settings:role:read, users:user:create or users:user:update.

Lists your organization's roles. Soft-deleted roles are left out unless includeDeleted is true. Needs the roles read or list permission, or the users create or update permission (the role picker on a user).

Errors: a failed call returns a GraphQL errors entry, not a field on the result, and data may be null or partial. Read the entry's extensions.code and message; every shape and code is in the Error reference.

Example:

GraphQL

query Roles {
  roles {
    id
    name
    displayName
    createdAt
    deletedAt
    deletedBy
    permissions {
      id
      name
      createdAt
      action
      description
      direct
    }
  }
}

cURL

curl -X POST "https://<api-host>/graphql" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  --data @- <<'EOF'
{
  "query": "query Roles {\n  roles {\n    id\n    name\n    displayName\n    createdAt\n    deletedAt\n    deletedBy\n    permissions {\n      id\n      name\n      createdAt\n      action\n      description\n      direct\n    }\n  }\n}"
}
EOF

Response:

{
  "data": {
    "roles": [
      {
        "id": "id",
        "name": "string",
        "displayName": "string",
        "createdAt": "2025-01-15T00:00:00Z",
        "deletedAt": "2025-01-15T00:00:00Z",
        "deletedBy": "string",
        "permissions": [
          {
            "id": "id",
            "name": "string",
            "createdAt": "2025-01-15T00:00:00Z",
            "action": "string",
            "description": "string",
            "direct": true
          }
        ]
      }
    ]
  }
}

roles(
  includeDeleted: Boolean
): [Role!]!

Arguments

roles.includeDeleted ● Boolean scalar

True to include soft-deleted roles. Leave out to exclude them.

Type

Role object

A role: a named set of permissions that can be given to users.