Skip to content
Get started

Refresh

client.auth.token.refresh(TokenRefreshParams { refresh } body, RequestOptionsoptions?): TokenRefreshResponse { access, refresh }
POST/api/auth/token/refresh/

Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.

ParametersExpand Collapse
body: TokenRefreshParams { refresh }
refresh: string
minLength1
ReturnsExpand Collapse
TokenRefreshResponse { access, refresh }
access: string
refresh: string
Refresh
import OvermindLab from 'overmind-lab';

const client = new OvermindLab();

const response = await client.auth.token.refresh({ refresh: 'x' });

console.log(response.access);
{
  "access": "access",
  "refresh": "refresh"
}
Returns Examples
{
  "access": "access",
  "refresh": "refresh"
}