On this page

effectivePermissions

query · in the family Reading your records

What it does

This page — the full picture of what a user may and may not do at an organization.

The verification mechanism: the FULL effective-permission map for an in-tenant (user, organization) pair — every registry operation evaluated by the SAME flat algorithm the future gate uses (default-DENY → union allow across the user's ACTIVE roles at the org → disallow-ALWAYS-wins), each entry attributing its contributing descriptors to their roles. Requires authentication; reads null when the user OR the organization is cross-tenant or absent. Previews DESCRIPTOR evaluation ONLY — no capability/dark-org/lifecycle composition (the ruled cutover slice).

Who may call it

Capability area: Reading your records — Looking up and listing the records of your organization.

Owner
System Administrator
Manager
Associate Manager
Sales Associate
An API key whose scope allows api:effectivePermissions

Arguments

Name	Type	Required	Notes
`userId`	ID `ID!`	yes	No further notes.
`organizationId`	ID `ID!`	yes	No further notes.

Returns

EffectivePermissions — The verification mechanism: (user, org) → the FULL effective-permission map + which role contributed each descriptor, computed by the SAME evaluator the future gate uses (preview ≡ enforcement — no second mechanism, no drift). Evaluates DESCRIPTORS ONLY: it does NOT compose the account-capability / dark-org / user-lifecycle gates.

Example request

query ExampleEffectivePermissions($userId: ID!, $organizationId: ID!) {
  effectivePermissions(userId: $userId, organizationId: $organizationId) {
    roles {
      roleId
      caption
      status
    }
  }
}

Variables:

{
  "userId": "01900000-0000-7000-8000-11f967df0000",
  "organizationId": "01900000-0000-7000-8000-44b781470000"
}

Example response

{
  "data": {
    "effectivePermissions": {
      "roles": [
        {
          "roleId": "01900000-0000-7000-8000-164531fc0000",
          "caption": "Blue jeans",
          "status": "<status>"
        }
      ]
    }
  },
  "extensions": {
    "at": {
      "callId": "01EXAMPLE-CALL-ID",
      "version": {
        "requested": null,
        "serviced": {
          "name": "genesis",
          "number": 0
        }
      }
    }
  }
}

Errors this call can answer

VALIDATION/INVALID — Something in the request is not valid. (VALIDATION)
AUTHN/REQUIRED — Sign in to do this. (AUTHN)
AUTHZ/FORBIDDEN — Your role does not allow this action. (AUTHZ)
RATE_LIMIT/THROTTLED — Too many requests in a short time. (RATE_LIMIT)
NOT_FOUND/* — That record could not be found. (NOT_FOUND)

Used in

Change what someone can do