Docs for Console and CLI user

On this page

Conventions
Probes
API description
GET /openapi.json
OpenID Connect provider
GET /oauth/authorize
GET /oauth/tenant/callback
POST /oauth/token
GET /.well-known/openid-configuration
GET /oauth/jwks
GET /oauth/userinfo
Decision contract
POST /v1/decisions
Access context contract
GET /v1/access-context
POST /v1/access-context
Administration
POST /v1/admin/tenants
GET /v1/admin/tenants
POST /v1/admin/users
GET /v1/admin/users
PUT /v1/admin/grants
DELETE /v1/admin/grants/{id}
GET /v1/admin/grants
POST /v1/admin/groups
GET /v1/admin/groups
PUT /v1/admin/roles
GET /v1/admin/roles
DELETE /v1/admin/roles/{id}
GET /v1/admin/audit
Session in twelve calls

HTTP API

Every Access endpoint with its request, response, errors and a curl example, ending with a tenant's whole session in twelve calls. It is written for developers and operators who call Access; the rules behind each endpoint are in the specification, cited as §N.

Read bySecurity engineer Application developer

Conventions#

Bodies are JSON. Errors are {"error": "<code>", "message": "<text>"}, except the token endpoint, which uses the OAuth shape {"error": "<code>", "error_description": "<text>"}.
Every response carries x-request-id (the client's own value if it sent a valid one), x-content-type-options: nosniff, x-frame-options: DENY and referrer-policy: no-referrer (§5.6).
The examples use https://access.example.com; replace it with your ACCESS_PUBLIC_URL (Configuration).
When a call fails, look the status and error code up in Troubleshooting.

Probes#

Endpoint	Response
`GET /healthz`	`200 {"status":"ok","service":"access","version":"<version>"}` (§12.1).
`GET /readyz`	`200 {"status":"ready"}`, `503 {"status":"draining"}` or `503 {"status":"not-ready"}` (§12.1).
`GET /metrics`	Prometheus text. `404` when `ACCESS_METRICS_TOKEN` is unset, `401` when the bearer token does not match.

bash

curl -sS https://access.example.com/healthz
curl -sS https://access.example.com/readyz
curl -sS https://access.example.com/metrics -H "authorization: Bearer $ACCESS_METRICS_TOKEN"

API description#

`GET /openapi.json`#

The OpenAPI description of the served paths and response shapes. The repository's API check (bun run api:check) compares it with the registered routes.

OpenID Connect provider#

`GET /oauth/authorize`#

Parameter	Rule
`client_id`	Required. Names the tenant (§5.2).
`redirect_uri`	Required. One of the tenant's `clientRedirectUris`; otherwise `400 invalid_request`.
`response_type`	Required. `code`.
`scope`	Optional. `openid profile email groups`.
`state`	Optional. Returned to the gateway.
`nonce`	Optional. Bound to the issued token.
`code_challenge`, `code_challenge_method`	Optional. `S256`.
`tenant`	Only when the tenant's client is `shared_client`.
`login_hint`	Optional. An e-mail, used only when the client is shared.

Response: 302 to the tenant's provider, 400 invalid_request (no tenant, bad parameters, unregistered redirect_uri) or 403 tenant_disabled.

`GET /oauth/tenant/callback`#

Where the tenant's provider returns the browser with code and state. Response: 302 to the request's redirect_uri with Access's code and the gateway's state. Refusals (§5.6): 400 login_state_invalid, 400 invalid_request, 403 identity_rejected, 403 identity_unknown, 403 principal_disabled, 403 provider_error, 403 tenant_disabled, 502 upstream_unavailable. An unexpected failure is 500 internal_error and never carries a dependency's error.

`POST /oauth/token`#

Exchanges the code for tokens; the client authenticates with client_secret_basic.

http

POST /oauth/token
Authorization: Basic {client_id}:{client_secret}
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code&code=…&redirect_uri=…&code_verifier=…

Field	Rule
`grant_type`	Required. `authorization_code`.
`code`	Required. The login code. Single use, 60 seconds.
`redirect_uri`	Required. Same as in the authorization request.
`code_verifier`	Required when the request carried a `code_challenge`.

json

{
  "access_token": "eyJ…",
  "token_type": "Bearer",
  "expires_in": 300,
  "id_token": "eyJ…"
}

No refresh token (§7.2); cache-control: no-store.

Error	When
`401 invalid_client`	Credentials missing, unreadable or wrong.
`400 invalid_request`	Bad grant type, missing code or redirect URI.
`400 invalid_grant`	Code unknown, expired, already used, or bound to another client, redirect URI or challenge.

`GET /.well-known/openid-configuration`#

The discovery document. Fields: §7.5.

`GET /oauth/jwks`#

The service's public keys; during a rotation, the current and previous key (§4.2).

`GET /oauth/userinfo`#

The claims of a bearer token's principal: sub, email, name, roles.

bash

curl -sS https://access.example.com/oauth/userinfo -H "authorization: Bearer $ACCESS_TOKEN"

401 when the token is expired, signed with another key, or issued for another audience.

Decision contract#

`POST /v1/decisions`#

http

POST /v1/decisions
Authorization: Bearer {ACCESS_DECISION_TOKEN}
Content-Type: application/json

{"subject":"…","workspaceId":"…","routeId":"…","roles":["…"]}

Field	Rule
`subject`	Required. A principal id (UUID).
`workspaceId`	Optional. Defaults to the empty string.
`routeId`	Optional. Defaults to the empty string.
`roles`	Optional. Defaults to an empty list. Roles are context, never policy (§8.4).

json

{"allow": true, "reason": "allowed"}
{"allow": false, "reason": "the principal does not have the role of the workspace", "reasonCode": "missing_role"}

Only a denial carries reasonCode (missing_role or access_denied), which always agrees with the text (§8.2, §8.7). The gateway treats every refusal as a denial:

Error	When
`401 unauthorized`	Credential missing or wrong.
`400 bad_request`	Body is not JSON, or the subject is not a string or not a principal id.
`503 service_unavailable`	Database down, or the decision took longer than `ACCESS_DECISION_TIMEOUT_MS`.

Credentials (§8.8): the deployment's bearer token (any principal) or a tenant's credentials (its principals only).

Access context contract#

A data-owning service reads a principal's complete capabilities for a workspace and route (§9). The credential is a dedicated read-only one from ACCESS_CONTEXT_TOKENS, scoped to listed tenants.

`GET /v1/access-context`#

Contract discovery, used by consumers as a readiness check.

http

GET /v1/access-context
Authorization: Bearer {access context credential}

json

{"versions":[1],"maxPermissionKeys":4096,"maxLifetimeMs":5000}

401 unauthorized when the credential is missing or wrong.

`POST /v1/access-context`#

A principal's context.

http

POST /v1/access-context
Authorization: Bearer {access context credential}
Content-Type: application/json

{"version":1,"subject":"…","tenantId":"…","workspaceId":"…","routeId":"…"}

Field	Rule
`version`	Required. `1`; any other value is `400 bad_request`.
`subject`	Required. A principal id (UUID).
`tenantId`	Required. The request's tenant (UUID).
`workspaceId`	Required. The request's workspace.
`routeId`	Required. The request's route.

Unknown or mistyped fields are refused; the body is at most 64 KiB.

json

{
  "version": 1,
  "allow": true,
  "subject": "…",
  "tenantId": "…",
  "workspaceId": "…",
  "routeId": "…",
  "permissionKeys": ["content.editor", "content.reader"],
  "evaluatedAt": "2026-10-21T16:00:00.000Z",
  "validUntil": "2026-10-21T16:00:05.000Z"
}

permissionKeys is complete, sorted and deduplicated; more than 4096 keys is 503 service_unavailable (§9.3). A denial is 200 with allow: false, empty permissionKeys and no validUntil.

Error	When
`401 unauthorized`	Credential missing or wrong.
`403 forbidden`	The credential may not ask about this tenant.
`400 bad_request`	Body not understood.
`503 service_unavailable`	The policy could not be fully evaluated.

Administration#

The twelve administrative endpoints live under /v1/admin, next to GET /v1/admin/audit; every call sends Authorization: Bearer <credential>. The credential is ACCESS_ADMIN_TOKEN or one from ACCESS_ADMIN_TOKENS (§4.6); a tenant credential acts only for its tenant, and naming another is 403 forbidden. Limits, pagination, error codes and auditing: §10.1.

`POST /v1/admin/tenants`#

Upsert by slug (§10.2).

bash

curl -sS -X POST https://access.example.com/v1/admin/tenants \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "slug": "acme",
        "displayName": "Acme Inc",
        "issuer": "https://login.acme.example",
        "idpClientId": "access-acme",
        "idpClientSecret": "the-secret-of-the-provider",
        "idpRedirectUri": "https://access.example.com/oauth/tenant/callback",
        "emailDomain": "acme.example",
        "clientId": "gateway-acme",
        "clientSecret": "the-secret-of-the-gateway",
        "clientRedirectUris": ["https://gateway-acme.example.com/auth/callback"],
        "autoProvision": false,
        "sharedClient": false,
        "default": false,
        "enabled": true
      }'

Field	Rule
`slug`	Required. `[a-z0-9-]{2,63}`. The row key.
`displayName`	Required.
`issuer`	Required. The tenant's provider issuer.
`idpClientId`	Required.
`idpClientSecret`	Required. Encrypted at rest, never returned.
`idpRedirectUri`	Optional. Default `https://{ACCESS_PUBLIC_URL}/oauth/tenant/callback`.
`idpScopes`	Optional. Default `["openid","email","profile"]`.
`idpAlgorithms`	Optional. Default `["RS256"]`.
`emailDomain`	Optional. Unique when set.
`clientId`	Required. The client id of the tenant's gateway at Access. Unique across tenants.
`clientSecret`	Required. Encrypted at rest, never returned. On replacement, the old secret stays valid for 24 hours alongside the new one.
`clientRedirectUris`	Optional. Default `[]`. The gateway's callback URLs; a tenant with none refuses every login.
`autoProvision`	Optional. Default `false`.
`sharedClient`	Optional. Default `false`. Platform operators only (§10.1).
`default`	Optional. Default `false`. At most one tenant. Platform operators only.
`enabled`	Optional. Default `true`.

409 conflict when the client id belongs to another tenant or a second default would appear; 403 forbidden when a tenant credential changes sharedClient or default.

json

{
  "id": "6f0f…", "slug": "acme", "displayName": "Acme Inc",
  "issuer": "https://login.acme.example", "emailDomain": "acme.example",
  "clientId": "gateway-acme",
  "clientRedirectUris": ["https://gateway-acme.example.com/auth/callback"],
  "autoProvision": false, "sharedClient": false,
  "default": false, "enabled": true,
  "createdAt": "2026-01-08T10:00:00.000Z"
}

`GET /v1/admin/tenants`#

Tenants with principal and grant counts.

bash

curl -sS https://access.example.com/v1/admin/tenants \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

json

{
  "tenants": [
    {
      "id": "6f0f…", "slug": "acme", "displayName": "Acme Inc",
      "issuer": "https://login.acme.example", "emailDomain": "acme.example",
      "clientId": "gateway-acme", "autoProvision": false, "sharedClient": false,
      "default": false, "enabled": true,
      "userCount": 42, "grantCount": 57,
      "createdAt": "2026-01-08T10:00:00.000Z"
    }
  ]
}

`POST /v1/admin/users`#

Upsert by (tenant, externalSubject) (§10.4).

bash

curl -sS -X POST https://access.example.com/v1/admin/users \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "tenant": "acme",
        "externalSubject": "00u1a2b3c4d5",
        "email": "alice@acme.example",
        "displayName": "Alice",
        "status": "active"
      }'

Field	Rule
`tenant`	Required. The tenant slug.
`externalSubject`	Required. The `sub` from the tenant's provider.
`email`	Optional. Published in the token until the provider says otherwise.
`displayName`	Optional.
`status`	Optional. `active` (default) or `disabled`.

404 not_found when the tenant is unknown.

json

{
  "id": "b1c2…", "tenant": "acme", "externalSubject": "00u1a2b3c4d5",
  "email": "alice@acme.example", "displayName": "Alice", "status": "active",
  "lastLoginAt": null, "createdAt": "2026-01-08T10:05:00.000Z"
}

Batch of principals#

Send principals instead of one principal:

bash

curl -sS -X POST https://access.example.com/v1/admin/users \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "principals": [
          {"tenant": "acme", "externalSubject": "00u1a2b3c4d5", "email": "alice@acme.example"},
          {"tenant": "acme", "externalSubject": "00u1a2b3c4d6", "email": "bob@acme.example"}
        ]
      }'

At most 1 000 per batch. Items are written separately, and a failed item does not stop the others (§10.4).

json

{
  "principals": [
    {"tenant": "acme", "externalSubject": "00u1a2b3c4d5", "id": "b1c2…", "created": true},
    {"tenant": "acme", "externalSubject": "00u1a2b3c4d6", "id": null, "created": false,
     "error": "not_found", "message": "the tenant does not exist"}
  ]
}

`GET /v1/admin/users`#

bash

curl -sS "https://access.example.com/v1/admin/users?tenant=acme&limit=50" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

Parameter	Rule
`tenant`	Optional. A tenant slug. Absent: every tenant.
`status`	Optional. `active` or `disabled`.
`email`	Optional. Exact e-mail match.
`limit`	Optional. Default `50`, maximum `200`.
`offset`	Optional. Default `0`.

json

{
  "principals": [
    {
      "id": "b1c2…", "tenant": "acme", "externalSubject": "00u1a2b3c4d5",
      "email": "alice@acme.example", "displayName": "Alice", "status": "active",
      "lastLoginAt": "2026-01-08T10:05:00.000Z",
      "createdAt": "2026-01-08T10:00:00.000Z"
    }
  ],
  "total": 42, "limit": 50, "offset": 0
}

Ordering and paging: §10.5.

`PUT /v1/admin/grants`#

Upsert by (tenant, user, permission, workspace, route) (§10.6).

bash

curl -sS -X PUT https://access.example.com/v1/admin/grants \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "tenant": "acme",
        "userId": "b1c2…",
        "permission": "workspace.read",
        "workspaceId": "11111111-1111-4111-8111-111111111111",
        "routeId": "workspace-api",
        "expiresAt": null
      }'

Field	Rule
`tenant`	Required. The tenant slug.
`userId`	The principal id. Exactly one of `userId` and `group` is required.
`group`	The group key. Exactly one of `userId` and `group` is required.
`permission`	The permission key, created in the tenant's scope if missing. Exactly one of `permission` and `role` is required.
`role`	The role key. The grant holds the role's permissions. An unknown role is `404 not_found`.
`workspaceId`	Optional. `null` (default) means every workspace of the tenant.
`routeId`	Optional. `null` (default) means every route.
`expiresAt`	Optional. An ISO 8601 instant; `null` (default) never expires.
`grantedBy`	Optional. Who granted it, for the audit log.

json

{
  "id": "d3e4…", "tenant": "acme", "userId": "b1c2…",
  "permission": "workspace.read",
  "workspaceId": "11111111-1111-4111-8111-111111111111",
  "routeId": "workspace-api", "expiresAt": null, "revokedAt": null,
  "createdAt": "2026-01-08T10:06:00.000Z"
}

Batch of grants#

Send {"grants": [ … ]} instead of one grant; the response reports each item:

json

{
  "grants": [
    {"tenant": "acme", "id": "d3e4…", "created": true},
    {"tenant": "acme", "id": null, "created": false,
     "error": "not_found", "message": "the principal does not exist"}
  ]
}

`DELETE /v1/admin/grants/{id}`#

Revokes a grant; the row is kept with revoked_at set.

bash

curl -sS -X DELETE https://access.example.com/v1/admin/grants/d3e4… \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -i

http

HTTP/1.1 204 No Content

Idempotent; 404 not_found for an unknown id (§10.7).

`GET /v1/admin/grants`#

bash

curl -sS "https://access.example.com/v1/admin/grants?tenant=acme&live=true" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

Parameter	Rule
`tenant`	Optional. A tenant slug. Absent: every tenant.
`userId`	Optional. A principal id.
`live`	Optional. `true`: grants neither revoked nor expired. `false`: the others. Absent: all.
`limit`	Optional. Default `50`, maximum `200`.
`offset`	Optional. Default `0`.

json

{
  "grants": [
    {
      "id": "d3e4…", "tenant": "acme", "userId": "b1c2…",
      "permission": "workspace.read",
      "workspaceId": "11111111-1111-4111-8111-111111111111",
      "routeId": "workspace-api", "expiresAt": null, "revokedAt": null,
      "grantedBy": "ops@example.com",
      "createdAt": "2026-01-08T10:10:00.000Z"
    }
  ],
  "total": 57, "limit": 50, "offset": 0
}

`POST /v1/admin/groups`#

Upsert by key; membership rules in §10.9.

bash

curl -sS -X POST https://access.example.com/v1/admin/groups \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "tenant": "acme",
        "key": "team-platform",
        "displayName": "The platform team",
        "members": ["00u1a2b3c4d5", "00u9z8y7x6w5"]
      }'

Field	Rule
`tenant`	Required. The tenant slug.
`key`	Required. `[a-z0-9][a-z0-9._-]{0,63}`.
`displayName`	Optional.
`members`	Optional. The members' external subjects.

json

{
  "id": "e5f6…", "tenant": "acme", "key": "team-platform",
  "displayName": "The platform team",
  "members": ["00u1a2b3c4d5", "00u9z8y7x6w5"],
  "createdAt": "2026-01-08T10:20:00.000Z"
}

`GET /v1/admin/groups`#

Groups, newest first.

bash

curl -sS "https://access.example.com/v1/admin/groups?tenant=acme&limit=20" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

Query	Rule
`tenant`	Optional. A tenant slug. Unknown tenant: `404 not_found`.
`key`	Optional. A group key.
`limit`	Optional. Default `50`, maximum `200`.
`offset`	Optional. Default `0`.

json

{
  "groups": [
    {
      "id": "e5f6…", "tenant": "acme", "key": "team-platform",
      "displayName": "The platform team",
      "members": ["00u1a2b3c4d5", "00u9z8y7x6w5"],
      "createdAt": "2026-01-08T10:20:00.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

`PUT /v1/admin/roles`#

Upsert by key; replaces the role's permissions and nested roles (§10.11).

bash

curl -sS -X PUT https://access.example.com/v1/admin/roles \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" \
  -H "content-type: application/json" \
  -d '{
        "tenant": "acme",
        "key": "role-editor",
        "displayName": "The editors",
        "description": "What the editors may do",
        "permissions": ["workspace.write"],
        "roles": ["role-reader"]
      }'

Field	Rule
`tenant`	Required. The tenant slug.
`key`	Required. `[a-z0-9][a-z0-9._-]{0,63}`.
`displayName`	Optional.
`description`	Optional.
`permissions`	Optional. Permission keys the role holds. Missing keys are created in the tenant's scope.
`roles`	Optional. Role keys the role names. An unknown key is `404 not_found`.

A role that names itself, directly or through others, is 409 conflict.

json

{
  "id": "a1b2…", "tenant": "acme", "key": "role-editor",
  "displayName": "The editors",
  "description": "What the editors may do",
  "permissions": ["workspace.write"],
  "roles": ["role-reader"],
  "createdAt": "2026-01-08T10:30:00.000Z"
}

`GET /v1/admin/roles`#

Roles, newest first.

bash

curl -sS "https://access.example.com/v1/admin/roles?tenant=acme&limit=20" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

Query	Rule
`tenant`	Optional. A tenant slug. Unknown tenant: `404 not_found`.
`key`	Optional. A role key.
`limit`	Optional. Default `50`, maximum `200`.
`offset`	Optional. Default `0`.

json

{
  "roles": [
    {
      "id": "a1b2…", "tenant": "acme", "key": "role-editor",
      "displayName": "The editors",
      "permissions": ["workspace.write"],
      "roles": ["role-reader"],
      "createdAt": "2026-01-08T10:30:00.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

`DELETE /v1/admin/roles/{id}`#

Removes a role that no grant names (§10.13).

bash

curl -sS -X DELETE https://access.example.com/v1/admin/roles/a1b2c3d4-… \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

`GET /v1/admin/audit`#

Reads the change audit (§10.15).

bash

curl -sS "https://access.example.com/v1/admin/audit?tenant=acme&limit=20" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

Query	Rule
`tenant`	Optional. A tenant slug. Unknown tenant: `404 not_found`.
`action`	Optional. An action name.
`limit`	Optional. Default `50`, maximum `200`. An export carries at most `10000`.
`offset`	Optional. Default `0`.
`format`	Optional. `json` (default), or `csv` / `jsonl` for an export. Anything else: `400 invalid_request`.

Actions: tenant.created, tenant.updated, principal.created, principal.updated, group.created, group.updated, grant.created, grant.updated, grant.revoked, role.created, role.updated, role.removed, and for a role's memberships role.permission.granted, role.permission.revoked, role.role.nested, role.role.unnested.

json

{
  "records": [
    {
      "id": "0f2c…",
      "at": "2026-01-08T10:30:00.000Z",
      "action": "grant.revoked",
      "targetId": "9fbfda13-…",
      "tenant": "acme",
      "operator": "6b1f2c9d0e3a",
      "address": "10.0.0.7",
      "requestId": "8452a08e-ebd7-4e61-ae99-fe051f3e531d"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}

operator is the credential's name, or the first twelve hex characters of its digest (§10.1).

Exporting the audit#

Add format to get a file:

bash

# CSV, for a spreadsheet
curl -sS "https://access.example.com/v1/admin/audit?format=csv&tenant=acme" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -o acme-audit.csv

# JSON Lines, for a script
curl -sS "https://access.example.com/v1/admin/audit?format=jsonl&tenant=acme" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -o acme-audit.jsonl

Filters apply. An export holds at most 10 000 rows; page with limit and offset beyond that.

csv

id,at,action,targetId,tenant,operator,address,requestId
0f2c…,2026-01-08T10:30:00.000Z,grant.revoked,9fbfda13-…,acme,6b1f2c9d0e3a,10.0.0.7,8452a08e-…

Session in twelve calls#

The twelve calls of the session take a tenant from registration to revocation, using each administration endpoint once. You need curl and jq.

bash

export ACCESS=https://access.example.com
export ACCESS_ADMIN_TOKEN=…

# 1. Register the tenant and its gateway
curl -sS -X POST $ACCESS/v1/admin/tenants \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -H "content-type: application/json" \
  -d '{"slug":"acme","displayName":"Acme Inc","issuer":"https://login.acme.example",
       "idpClientId":"access-acme","idpClientSecret":"…","clientId":"gateway-acme",
       "clientSecret":"…","emailDomain":"acme.example",
       "clientRedirectUris":["https://gateway-acme.example.com/auth/callback"]}'

# 2. List tenants with their counts
curl -sS $ACCESS/v1/admin/tenants -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

# 3. Create the principal of an external identity
USER_ID=$(curl -sS -X POST $ACCESS/v1/admin/users \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -H "content-type: application/json" \
  -d '{"tenant":"acme","externalSubject":"00u1a2b3c4d5","email":"alice@acme.example"}' | jq -r .id)

# 4. List the tenant's principals
curl -sS "$ACCESS/v1/admin/users?tenant=acme" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

# 5. Grant a permission on a workspace and route
GRANT_ID=$(curl -sS -X PUT $ACCESS/v1/admin/grants \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -H "content-type: application/json" \
  -d '{"tenant":"acme","userId":"'"$USER_ID"'","permission":"workspace.read",
       "workspaceId":"11111111-1111-4111-8111-111111111111","routeId":"workspace-api"}' | jq -r .id)

# 6. List the tenant's grants
curl -sS "$ACCESS/v1/admin/grants?tenant=acme" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

# 7. Create a group; a grant to the group applies to every member
curl -sS -X POST $ACCESS/v1/admin/groups \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -H "content-type: application/json" \
  -d '{"tenant":"acme","key":"team-platform","displayName":"The platform team",
       "members":["00u1a2b3c4d5"]}'

# 8. List the tenant's groups
curl -sS "$ACCESS/v1/admin/groups?tenant=acme" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

# 9. Create a role holding a permission
ROLE_ID=$(curl -sS -X PUT $ACCESS/v1/admin/roles \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN" -H "content-type: application/json" \
  -d '{"tenant":"acme","key":"role-editor","displayName":"The editors",
       "permissions":["workspace.write"]}' | jq -r .id)

# 10. List the tenant's roles
curl -sS "$ACCESS/v1/admin/roles?tenant=acme" \
  -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

# 11. Remove the role (no grant names it)
curl -sS -X DELETE $ACCESS/v1/admin/roles/$ROLE_ID -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

# 12. Revoke the grant when access must end
curl -sS -X DELETE $ACCESS/v1/admin/grants/$GRANT_ID -H "authorization: Bearer $ACCESS_ADMIN_TOKEN"

To grant a role, send "role":"role-editor" instead of "permission" in step 5. scripts/cli/admin-smoke.ts runs the same sequence against a deployment:

bash

ACCESS_URL=$ACCESS ACCESS_ADMIN_TOKEN=$ACCESS_ADMIN_TOKEN bun run scripts/cli/admin-smoke.ts

Conventions#

Probes#

API description#

GET /openapi.json#

OpenID Connect provider#

GET /oauth/authorize#

GET /oauth/tenant/callback#

POST /oauth/token#

GET /.well-known/openid-configuration#

GET /oauth/jwks#

GET /oauth/userinfo#

Decision contract#

POST /v1/decisions#

Access context contract#

GET /v1/access-context#

POST /v1/access-context#

Administration#

POST /v1/admin/tenants#

GET /v1/admin/tenants#

POST /v1/admin/users#

Batch of principals#

GET /v1/admin/users#

PUT /v1/admin/grants#

Batch of grants#

DELETE /v1/admin/grants/{id}#

GET /v1/admin/grants#

POST /v1/admin/groups#

GET /v1/admin/groups#

PUT /v1/admin/roles#

GET /v1/admin/roles#

DELETE /v1/admin/roles/{id}#

GET /v1/admin/audit#

Exporting the audit#

Session in twelve calls#

`GET /openapi.json`#

`GET /oauth/authorize`#

`GET /oauth/tenant/callback`#

`POST /oauth/token`#

`GET /.well-known/openid-configuration`#

`GET /oauth/jwks`#

`GET /oauth/userinfo`#

`POST /v1/decisions`#

`GET /v1/access-context`#

`POST /v1/access-context`#

`POST /v1/admin/tenants`#

`GET /v1/admin/tenants`#

`POST /v1/admin/users`#

`GET /v1/admin/users`#

`PUT /v1/admin/grants`#

`DELETE /v1/admin/grants/{id}`#

`GET /v1/admin/grants`#

`POST /v1/admin/groups`#

`GET /v1/admin/groups`#

`PUT /v1/admin/roles`#

`GET /v1/admin/roles`#

`DELETE /v1/admin/roles/{id}`#

`GET /v1/admin/audit`#