permissions

Requires an authenticated session.

Lists the permissions a tenant may grant, optionally narrowed by module or resource. Platform-reserved permissions are never listed.

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 Permissions {
  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 Permissions {\n  permissions {\n    id\n    name\n    createdAt\n    action\n    description\n    direct\n  }\n}"
}
EOF

Response:

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

permissions(
  module: String
  resource: String
): [Permission!]!

Arguments

permissions.module ● String scalar

Only permissions in this module.

permissions.resource ● String scalar

Only permissions on this resource.

Type

Permission object

A permission.