Skip to main content
POST
Revoke an on-behalf-of grant
Revokes one on-behalf-of (acting-for) grant by grantId, as the Forge Console’s Delegation page revokes it. The grant stays listed as revoked, with the calling credential as who revoked it; note, when given, replaces the grant’s note (at most 280 characters). Revoking a revoked grant changes nothing (changed: false). Your role grants, narrowed by your credential’s scopes, must hold grants:manage at the platform scope; a grant at an org unit does not count. The audit trail records the change, naming the credential. An unknown grantId is 404 resource_missing. With an Idempotency-Key, a retry within 24 hours returns the recorded result while you still hold grants:manage at the platform scope.

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Headers

Idempotency-Key
string

Optional logical intent key. A same-key retry within 24 hours returns the recorded result without changing anything again.

Required string length: 1 - 255

Path Parameters

grantId
string
required

The on-behalf-of grant's id.

Minimum string length: 1

Body

application/json

Revoke one on-behalf-of grant.

note
string

A note stored on the revoked grant, replacing its note (at most 280 characters).

Maximum string length: 280

Response

Revoke an on-behalf-of grant

data
object
required

changed is false when the grant was already revoked.

meta
object
required