Third Party Authentication

Contains operations for the OAuth 2.0 Authorization Code Flow Token Exchange.

Operations

Token refresh or exchange

Request

Exchanges the OAuth2 authorization code for an access token, or refreshes an existing access token using a refresh token.

Bodyapplication/json

One of:

grant_typestringrequired

Value:"refresh_token"

refresh tokenstring

{
  "grant_type": "refresh_token",
  "refresh_token": "6kuabo4gug8t9h13x7gt43cm"
}

Responses

Bodyapplication/json

One of:

scopestring

The scope of the access request. Supported scopes: user.account:read, user.profile:read and user.profile:update

Example:"user.account:read user.profile:read user.profile:update"

access_tokenstring

The access token that can be used to obtain account and profile information

Example:"oa_nj1dfhecrs1jwxi0wd0xk49n"

token_typestring

Token type to be used in the Authorization header when requesting the resource's owner information

Example:"bearer"

expires_innumber

The lifetime in seconds of the access token

Example:3600

refresh_tokenstring

Example:"6kuabo4gug8t9h13x7gt43cm"

user_idstring

Zephr user identifier

Example:"1234567890"

Response

{
  "scope": "user.account:read user.profile:read user.profile:update",
  "access_token": "oa_nj1dfhecrs1jwxi0wd0xk49n",
  "token_type": "bearer",
  "expires_in": 3600,
  "refresh_token": "6kuabo4gug8t9h13x7gt43cm",
  "user_id": "1234567890"
}