Sign in

v2

latestOpenAPI 3.0.02026-07-31172752.6 KB
access_revocations

Create an access revocation

Creates a revocation for the access identified by access_state_id. For a resource-scoped access state, produces one revocation against that resource.For an app-wide access state (no resource), produces the equivalent app-wide revocation.

post/api/v1/access_revocations

Headers

Idempotency-Keystring

Optional key (1–255 chars) for safely retrying a request. Reusing the same key for the same request returns 409 Conflict and is not processed again — this confirms the request was already received. Keys are retained for 14 days.

Request body

access_state_idstring uuid required

Access state ID identifying the access to revoke

reasonstring required

Reason for the revocation

Example request

{
  "access_state_id": "7488a646-e31f-11e4-aace-600308960663",
  "reason": "Role no longer requires this access"
}

Response

Access revocation created

application_idstring uuid required

Application ID

grantee_user_idstring uuid

User ID of the grantee

idstring uuid required

Access revocation ID

inserted_atstring date-time

Creation timestamp

permission_idsstring[] nullable

Permission IDs being revoked

provisioning_type'application_admin' | 'automatic' nullable

Provisioning type

reasonstring required

Revocation reason

requestor_user_idstring uuid

User ID of the requestor

resource_idstring uuid nullable

Resource ID (null for app-wide revocations)

status'processing_access' | 'rejected' | 'revoked' required

Current status of the revocation