permission

Requires an authenticated session.

Returns one permission by ID.

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 Permission($id: ID!) {
  permission(id: $id) {
    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 Permission($id: ID!) {\n  permission(id: $id) {\n    id\n    name\n    createdAt\n    action\n    description\n    direct\n  }\n}",
  "variables": {
    "id": "id"
  }
}
EOF

Variables:

{
  "id": "id"
}

Response:

{
  "data": {
    "permission": {
      "id": "id",
      "name": "string",
      "createdAt": "2025-01-15T00:00:00Z",
      "action": "string",
      "description": "string",
      "direct": true
    }
  }
}

permission(
  id: ID!
): Permission!

Arguments

permission.id ● ID! non-null scalar

The ID of the permission.

Type

Permission object

A permission.