oauth-grants

Revoke one of the caller's own delegated-access grants by id

Revoke one of the caller's own OAuth grants, by id, withdrawing an agent's consent to act on the caller's behalf. Authenticated only: no role check, and no gateway ownership pre-fetch, because the control plane resolves "me" from the asserted bearer. A delegated caller (an agent acting for the user) is refused with a 404, because a borrowed authority must not revoke a peer's consent. A malformed grant_id (not oauthgrant_<21 alphanumerics>) is the same non-disclosing 404, never a 400 - the format check is also what keeps a caller-supplied id from being interpolated into an upstream path. The request body is forwarded verbatim.

post/registry/v1/users/me/oauth-grants/{grant_id}/revoke

Request

  • Base URL: https://api.atlan.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.atlan.com/registry/v1/users/me/oauth-grants/{grant_id}/revoke
  • Auth: HTTP bearer

Path parameters

grant_idstring required

The control-plane OAuth-grant id (oauthgrant_<21>).

Headers

Content-Encoding'base64' | 'gzip, base64'

Codings applied to the request body, outermost last. Send base64, or gzip, base64 to compress first; the body is decoded before it is read and Content-Type still names the inner media type. Omit for an unencoded body.

Response

The grant was revoked; the body is the revoked grant.

actor_substring required

The agent's service account acting on the caller's behalf.

client_idstring required

The OAuth client the grant was made to.

created_atstring date-time required

When the grant was made.

expires_atstring date-time required

When the grant expires.

idstring required

The grant id.

revoked_atstring date-time

When the grant was revoked, if it was.

status'active' | 'revoked' | 'expired' required

A delegated-access grant's lifecycle state.

Changes

No recorded changes to this operation across all 1 revision of this API.