Skip to main content
PUT
Replace object access grants

Authorizations

Authorization
string
header
required

Send Authorization: Bearer <credential> using either a Clerk session JWT or a Clerk API key (ak_*). API keys may identify a user (user_*) or organization (org_*) principal and are generated in the Clerk Dashboard under API keys.

Path Parameters

resourceKind
enum<string>
required
Available options:
dashboard,
report,
budget,
costAlert
resourceId
string
required
Minimum string length: 1

Body

application/json
grants
object[]
required

Full replacement of direct grants. Omitted principals lose access. Every object must retain a USER, TEAM, or CLERK_ADMIN Admin grant. Each principal may appear once.

Response

Grants after the replacement

grants
object[]
required
callerRole
enum<string> | null
required
Available options:
READER,
EDITOR,
ADMIN,
null
capabilities
object
required
availableRoles
enum<string>[]
required
Available options:
READER,
EDITOR,
ADMIN
Last modified on October 12, 2026