On this page
myEffectivePermissions
query · in the family Your own session
What it does
Your own access at the organization you are acting in — every operation and whether your roles allow it, and why.
YOUR OWN effective permissions at the organization you are acting in — the SAME evaluator and the SAME answer shape as effectivePermissions (roles · operations over the WHOLE registry), computed over the session's own user and acting organization (no arguments). SELF on the USER plane — every principal keeps it (an API key or a collaborator has no own user → AUTHZ/FORBIDDEN, never a synthetic answer); the office's lens read, so every reader's course narrows to what their role can run.
What happens
Read-only; your own alone.
Who may call it
Capability area: Your own session — What every signed-in person may do for themselves — their session, their profile and their own work.
- Owner
- System Administrator
- Manager
- Associate Manager
- Warehouse Associate
- Sales Associate
- Cashier
- An API key whose scope allows
api:myEffectivePermissions
Returns
EffectivePermissions 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 ExampleMyEffectivePermissions {
myEffectivePermissions {
roles {
roleId
caption
status
}
}
}
Example response
{
"data": {
"myEffectivePermissions": {
"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)