Revoke Token

POST

/iam/v1/tokens:revoke

curl --request POST \
  --url https://example.com/iam/v1/tokens:revoke \
  --header 'Content-Type: application/json' \
  --data '{ "token_hash": "example" }'

Revokes a session token, immediately terminating the session and any sibling tokens in the same family (cascade via family_id).

Empty token_hash → revoke the bearer credential extracted from the Authorization header (the common “log me out” case). Non-empty token_hash → revoke the named session. Caller must own the session OR hold platform-scoped iam.token.revoke.

Returns NOT_FOUND if the hash does not exist OR if the caller is not permitted to see it (existence-leak suppression).

Request Body ^required

Media type application/json

RevokeTokenRequest

Request message for RevokeToken. Carries an optional token_hash identifying the session to revoke. Empty form (self-revoke) targets the bearer credential from the Authorization header; populated form targets the named session.

No buf.validate constraint on token_hash length — empty IS the valid self-revoke form. Length validation (128 lowercase hex chars when populated) runs in the handler so empty + populated both flow through one entry point.

object

token_hash

Optional. SHA-512 hex fingerprint of the access OR refresh token to revoke. Leave empty to revoke the bearer credential from the Authorization header.

string

Example ^generated

{
  "token_hash": "example"
}

Responses

200

OK

Media type application/json

IAM Operation

An acknowledgment of a mutation request, carrying tracking metadata, errors, and warnings. Follows GCP’s Operations pattern (AIP-151).

object

id

Operation ID

Unique identifier for this operation.

stringOutput only

resource_id

Resource ID

The ID of the resource affected by this operation. May be empty for async operations where the resource does not yet exist.

stringOutput only

resource_type

Resource Type

The type of resource (e.g., “User”, “Role”, “IamBinding”).

stringOutput only

operation_type

Operation Type

The kind of mutation that was requested.

string format: enum Output only

Allowed values: IAM_OPERATION_TYPE_UNSPECIFIED IAM_OPERATION_TYPE_CREATE IAM_OPERATION_TYPE_UPDATE IAM_OPERATION_TYPE_DELETE IAM_OPERATION_TYPE_AUTHENTICATE IAM_OPERATION_TYPE_CHANGE_PASSWORD IAM_OPERATION_TYPE_REVOKE IAM_OPERATION_TYPE_GRANT IAM_OPERATION_TYPE_INVITE IAM_OPERATION_TYPE_DEACTIVATE IAM_OPERATION_TYPE_REACTIVATE IAM_OPERATION_TYPE_ACTIVATE IAM_OPERATION_TYPE_UPLOAD_AVATAR IAM_OPERATION_TYPE_CLEAR_AVATAR

status

Status

Current lifecycle state of the operation.

string format: enum Output only

Allowed values: IAM_OPERATION_STATUS_UNSPECIFIED IAM_OPERATION_STATUS_PENDING IAM_OPERATION_STATUS_RUNNING IAM_OPERATION_STATUS_DONE IAM_OPERATION_STATUS_ERROR

insert_time

Insert Time

When the operation was first created.

string format: date-time Output only

start_time

Start Time

When the operation started executing.

string format: date-time Output only

end_time

End Time

When the operation completed (either successfully or with errors).

string format: date-time Output only

errors

Errors

Business rule errors encountered during the operation.

Array<object>Output only

Operation Error

A structured error returned inside an operation when a business rule fails.

object

code

Error Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the error.

stringOutput only

warnings

Warnings

Non-fatal notices about the operation.

Array<object>Output only

Operation Warning

A non-fatal notice attached to an operation.

object

code

Warning Code

Numeric identifier following the S_SSS_EEE convention.

integer format: uint32 Output only

description

Description

Human-readable explanation of the warning.

stringOutput only

progress

Progress

Percentage of completion (0-100).

integer format: int32 Output only

cause

Revocation Cause

Discriminator for REVOKE operations only (UNSPECIFIED for every other operation_type). See RevocationCause for the four flavours.

string format: enum Output only

Allowed values: REVOCATION_CAUSE_UNSPECIFIED REVOCATION_CAUSE_SELF REVOCATION_CAUSE_TARGETED REVOCATION_CAUSE_ADMIN_TARGETED REVOCATION_CAUSE_SESSION_CAP_EXCEEDED

Example

{
  "operation_type": "IAM_OPERATION_TYPE_UNSPECIFIED",
  "status": "IAM_OPERATION_STATUS_UNSPECIFIED",
  "cause": "REVOCATION_CAUSE_UNSPECIFIED"
}

default

Default error response

Media type application/json

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the API Design Guide.

object

code

The status code, which should be an enum value of [google.rpc.Code][google.rpc.Code].

integer format: int32

message

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

string

details

A list of messages that carry the error details. There is a common set of message types for APIs to use.

Array<object>

Contains an arbitrary serialized message along with a @type that describes the type of the serialized message.

object

@type

The type of the serialized message.

string

key

additional properties

any

Example ^generated

{
  "code": 1,
  "message": "example",
  "details": [
    {
      "@type": "example"
    }
  ]
}