v11

latestOpenAPI 3.1.0OGL-UK-3.0raw.githubusercontent.com2026-07-0391724.3 KB
Allowlist

Resolve grants accessible to a user

Returns the list of active grants the user identified by crn and sbi is permitted to access. The user identity is read from the x-encrypted-auth JWT header (signed with ENCRYPTED_AUTH_JWT_SECRET), which must contain crn and sbi claims.

Access rules (evaluated per environment):

  • Grants with no allowlist entries are closed to all users.
  • Grants with allowAll: true in their allowlist.yaml are open to all users.
  • Otherwise the user must appear in both the CRN and SBI lists.

The allowlist.yaml format (per environment, per grant config):

dev:
  allowAll: true        # open to everyone in dev
test:
  crns:
    - '1234567890'
  sbis:
    - '123456789'
get/allowlist/grants

Response

List of grants the user may access