role

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

Returns one role of your organization by ID. Needs the roles read permission or the users update permission.

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 Role($id: ID!) {
  role(id: $id) {
    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 Role($id: ID!) {\n  role(id: $id) {\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}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "role": {
      "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
        }
      ]
    }
  }
}

role(
  id: ID!
): Role!

Arguments

role.id ● ID! non-null scalar

The ID of the role.

Type

Role object

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