AccessToken

3PP exchanges the authorization code for an access token and refresh token.
After 3PP gets authorization code, they need to exchange the authorization token for an access token and refresh token.

Request

Query Params

client_id

string

required

The ID of 3PP offered by OC offline

grant_type

string

required

Fixed value: "authorization_code"

redirect_uri

string

required

To prevent attack, OC validates value of this field against the redirect URL that was used when requesting the authorization code. The two redirect URLs should be the same.

code

string

required

Value of authorization code

Responses

🟢200OK

application/json

Body

access_token

string

optional

Value of access token. When 3PP requests APIs (exclude "getServiceList" API), access token should be contained in a header named "Access-Token".

error

string

optional

error_description

string

optional

expires_in

integer <int32>

optional

Duration of validity of access token.

refresh_token

string

optional

Value of refresh token. If the access token is expired, 3PP uses the refresh token to get a new access token and its expiration date.

token_type

string

optional

Fixed value: "bearer"

Example

{
  "access_token": "string",
  "error": "string",
  "error_description": "string",
  "expires_in": 0,
  "refresh_token": "string",
  "token_type": "string"
}

🟢201Created

🟠401Unauthorized

🟠403Forbidden

🟠404Not Found

Request

Request samples

Responses