║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║

---

title: 'revokeToken()' description: Use Clerk's JS Backend SDK to revoke a M2M token. sdk: js-backend

Revokes an M2M token. This endpoint can be authenticated by either a Machine Secret Key or by a Clerk Secret Key.

• When revoking a M2M token with a Machine Secret Key, the token must be managed by the Machine associated with the Machine Secret Key.
• When revoking a M2M token with a Clerk Secret Key, any token on the instance can be revoked.

function revokeToken(params: RevokeM2MTokenParams): Promise<M2MToken>

RevokeM2MTokenParams

<Properties> - `machineSecretKey?` - `string`

Custom machine secret key for authentication. If not provided, the SDK will use the value from the environment variable.

---

• m2mTokenId
• string

The ID of the M2M token to revoke.

---

• revocationReason?
• string | null

Optional reason for revocation. Useful for your records. </Properties>

Example

<Include src="_partials/backend/usage" />

const response = await clerkClient.m2m.revokeToken({ m2mTokenId })

Backend API (BAPI) endpoint

This method in the SDK is a wrapper around the BAPI endpoint POST/m2m_tokens/{m2m_token_id}/revoke. See the BAPI reference{{ target: '_blank' }} for more information.

║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║
║