Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

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 / refresh

Function: refresh() ​

refresh<Schema>(mode, refresh_token?): RestCommand<AuthenticationData, Schema>

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

Retrieve a new access token using a refresh token.

Type Parameters ​

• Schema

Parameters ​

mode ​

AuthenticationMode = 'cookie'

Whether to submit and retrieve the refresh token in the JSON response, or in a httpOnly cookie.

refresh_token? ​

string

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

Returns ​

RestCommand<AuthenticationData, Schema>

The new access and refresh tokens for the session.