Skip to main content

Function: refreshAccessToken()

refreshAccessToken(host, props, validateResults?): Promise<{ accessToken: string; }>

Refreshes an access token using a refresh token. The token type is automatically inferred from the token prefix:

  • ut_ prefix for session tokens
  • st_ prefix for API tokens

Parameters​

host​

string

The API host URL

props​

The request properties

body​

{ refreshToken: string; } = refreshAccessTokenBodySchema

Request body with refresh token (type is inferred from prefix)

body.refreshToken​

string = ...

validateResults?​

boolean = false

Returns​

Promise<{ accessToken: string; }>

Promise resolving to a new access token

Operation Id​

refresh-access-token