Skip to main content
Effective capabilities of the request's principal.

Authorizations

Authorization
string
header
required

Capability-bearing token issued by a squash operator. Required for curation, exports, dataset registration, and job control when the deployment runs in gated mode; public reads stay open. GET /api/access reports the capabilities a given credential actually carries.

Headers

Authorization
string | null

Optional bearer credential

X-Squash-Organization-Id
string | null

Optional organization selector for the legacy CLI operator

Response

Effective request capabilities

Effective access granted to the principal represented by the request.

capabilities
enum<string>[]
required

Finite wire values returned by GET /api/access.

Available options:
view_data,
view_internals,
curate_data,
export_data,
manage_datasets,
manage_jobs
scope
object
required

The tenant boundary applied to every dataset, job, event, and storage key.

writes_require_admin
boolean
required

true exactly when the server runs in gated mode (an admin token is configured): privileged endpoints require an authorization bearer token, while public reads stay open. false in open mode.