Directus / @directus/sdk / rest / logout

Function: logout() ​

logout<Schema>(refresh_token?, mode?): RestCommand<void, Schema>

Defined in: rest/commands/auth/logout.ts:13

Invalidate the refresh token thus destroying the user's session.

Type Parameters ​

• Schema

Parameters ​

refresh_token? ​

string

The refresh token to invalidate. If you have the refresh token in a cookie through /auth/login, you don't have to submit it here.

mode? ​

AuthenticationMode = 'cookie'

Whether the refresh token is submitted in the JSON response, or in a httpOnly cookie.

Returns ​

RestCommand<void, Schema>

Empty body.