Skip to main content
Check the access granted by a bearer token.

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

Bearer access token. Omit only to inspect unauthenticated access.

X-Squash-Organization-Id
string | null

Operator-only organization selector. Customers must omit this header.

Response

Resolved scope and capabilities

Scope and capabilities granted to the request.

capabilities
enum<string>[]
required

Actions allowed for this token. Customer tokens include view_data.

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

Data scope used for dataset requests.

writes_require_admin
boolean
required

Whether privileged write endpoints require an admin token.