Update a grant

View as Markdown
Update an identity grant's metadata. Use this to change the associated policy, update the grantor, or adjust grant timestamps. **Updatable fields:** - `status` — transition the grant to a new status - `policy_id` or `policy_key` — reassign the grant to a different access policy - `granted_by` — update the grantor identifier - `granted_at` — correct the grant timestamp To revoke a grant, use the dedicated `POST /iga/grants/{grant_id}/revoke` endpoint instead — it handles deprovisioning workflows.

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

grant_idstringRequired

Headers

X-Workspace-IdstringOptional

Request

Request body for updating a grant via the public API
statusenumOptional
Allowed values:
policy_idlongOptional
Change the policy associated with the grant
policy_keystringOptional

Change the policy by key (alternative to policy_id)

granted_bylongOptional
User ID who authorized this grant
granted_atdatetimeOptional
When the grant was authorized

Response

Successful response