Appearance

On this page

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / rest / logout

Function: logout() ​

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

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

Type parameters ​

• Schema extends object

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.

Source ​

rest/commands/auth/logout.ts:13