DEdefra
Allowlist

Resolve grants accessible to a user

Changed on

Returns the list of active grants the user identified by sbi is permitted to access.

The user's identity is supplied in the x-user-context header as a JWT containing an sbi claim. The JWT is signed by the calling service using the shared ENCRYPTED_AUTH_JWT_SECRET.

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 the SBI list.

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

dev:
  allowAll: true
test:
  sbis:
    - '123456789'
get/allowlist/grants

Request

  • Base URL
    http://localhost:3001
  • URL
    http://localhost:3001/allowlist/grants
  • Auth
    HTTP bearer and API key in header x-user-context

Response

List of grants the user may access

Changes

  • eca9a29240aeRevision changes
    • info

      the endpoint scheme security bearerAuth AND userContext was added to the API

    • info

      the endpoint scheme security bearerAuth AND encryptedAuth was removed from the API

  • 047f9b2e19c3Revision changes
    • warning

      deleted the header request parameter x-encrypted-auth

    • info

      the endpoint scheme security bearerAuth AND encryptedAuth was added to the API