Skip to main content
GET
List Grants

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.

Query Parameters

agent_id
string | null
state
string
default:in_force

in_force (default), pending_approval, expired, revoked or all

Pattern: ^(in_force|pending_approval|expired|revoked|superseded|all)$
not_enforcing
boolean | null

only grants in observe, shadow or canary (or only enforcing ones)

q
string | null

matches a grant id, a principal or an agent's name

sort
string | null

column, '-' prefix for descending

limit
integer
default:25
Required range: 1 <= x <= 200
offset
integer
default:0
Required range: x >= 0

Response

Successful Response

A page of grants, and the size of the set it came from.

total is the FILTERED set, not the page; see TrajectoryPageOut.

grants
GrantOut · object[]
required
total
integer
required
limit
integer
required
offset
integer
required
has_more
boolean
default:false