Skip to navigation

Revoke a grant

View as Markdown

Revoke a grant. By default (skip_deprovisioning=true), marks the grant as REVOKED immediately without triggering IDP deprovisioning. Set skip_deprovisioning=false to trigger the full deprovisioning workflow (Azure AD/Okta group removal or service request creation).

Authentication

X-Api-Keystring
API Key authentication via header

Path parameters

grant_idlongRequired
The grant ID to revoke

Headers

X-Workspace-IdstringOptional

Request

Request body for revoking a grant via the public API
reasonstringOptional
Optional reason for revoking the grant
skip_deprovisioningbooleanOptionalDefaults to true

When true (default), marks the grant as REVOKED immediately without triggering IDP deprovisioning. When false, triggers the full deprovisioning workflow (Azure AD/Okta group removal or service request creation).

Response

Successful response