Skip to content
On this page

Function: revokeToken()

TypeScript
function revokeToken(token: string | readonly string[], options?: RevokeTokenOptions): Promise<RevokeTokenResult>;

Defined in: me-client/src/tokens.ts:132 (opens in a new tab)

End a sign-in token at the auth host (POST /api/auth/revoke), on every site that reads the list of ended sessions. Holding a token is the authority to end it; nothing else is sent. Call it once your own session has taken over. Takes one token or up to eight. An outage is a result, never a throw, so it can't break a sign-in.

ParametersLink to this section

ParameterType
tokenstring | readonly string[]
optionsRevokeTokenOptions

ReturnsLink to this section

Promise<RevokeTokenResult>