Skip to main content
POST
Preview Grant

Authorizations

Authorization
string
header
required

A token from the identity provider your deployment federates with. It identifies a person; their roles in the workspace decide what they may do.

Body

application/json
agent_id
string
required
principal_id
string
required
principal_type
string
default:human
Pattern: ^(human|team|service)$
scope
Scope · object
audience
string | null
Maximum string length: 500
policy
string | null
Maximum string length: 20000
budget_amount_minor
integer | null
Required range: x >= 0
budget_currency
string | null
Required string length: 3
budget_count
integer | null
Required range: x >= 0
ttl_hours
integer
default:24
Required range: x >= 1
conditions
Conditions · object
delegation_policy
string
default:none
Pattern: ^(none|attenuating)$
enforcement_mode
string
default:enforce
Pattern: ^(observe|shadow|canary|enforce)$
canary_percent
integer | null
Required range: 0 < x <= 100
signing_assertion
Signing Assertion · object | null
signing_challenge
string | null
signing_token
string | null

Response

Successful Response

What the browser must sign, and the token that pins it.

statement
string
required
challenge
string
required
token
string
required
policy_rendering
string | null
bounds_rendering
string[]
policy_vacuity
Policy Vacuity · object | null
policy_unreachable_bounds
Policy Unreachable Bounds · object[]