Class Authentication

Creates a Bearer token required to authorize OAuth API calls.

Success response schema:

interface res {
  access_token: string
  token_type: string = 'Bearer'
  expires_in: number
  refresh_token: string
  created_at: number
}

Failure response schema: Error schema

Example:

const token = await client.authentication.getToken({
  username: 'spree@example.com',
  password: 'spree123'
})

Refreshes the Bearer token required to authorize OAuth API calls.

Success response schema:

interface res {
  access_token: string
  token_type: string = 'Bearer'
  expires_in: number
  refresh_token: string
  created_at: number
}

Failure response schema: Error schema

Example:

const token = await client.authentication.refreshToken({
  refresh_token: 'aebe2886d7dbba6f769e20043e40cfa3447e23ad9d8e82c632f60ed63a2f0df1'
})

Revokes a Bearer token (access token) or a refresh token.

Success response schema: Success schema

Failure response schema: Error schema

Example:

const response = await client.authentication.revokeToken({
  token: 'aebe2886d7dbba6f769e20043e40cfa3447e23ad9d8e82c632f60ed63a2f0df1'
})