One-time tokens

Update one-time token status

Update the status of a one-time token by its ID. This can be used to mark the token as consumed or expired.

put/api/one-time-tokens/{id}/status

Request

  • Base URL: https://[tenant_id].logto.app
  • URL: https://[tenant_id].logto.app/api/one-time-tokens/{id}/status
  • Auth: OAuth 2 (client credentials, token URL /oidc/token, scopes: all)

Path parameters

idstring required

The unique identifier of the one time token.

Request body

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

The new status of the one-time token.

Response

The one-time token status was updated successfully.

tenantIdstring required
idstring required
emailstring required
tokenstring required
status'active' | 'consumed' | 'revoked' | 'expired' required
createdAtnumber required
expiresAtnumber required

Changes

No recorded changes to this operation across all 8 revisions of this API.