OAuth

Exchange OAuth token by third-party code

Changed on

Exchanges a one-time third_party_exchange_code returned by POST /api/v1/oauth/token for the same Aura Historia access token. No client credentials or bearer token are required.

The exchange code expires after 60 seconds and is deleted whether the exchange succeeds or fails due to expiry.

get/api/v1/oauth/tokens/by-third-party-code/{thirdPartyCode}

Request

  • Base URL: https://api.stage.aura-historia.com
  • URL: https://api.stage.aura-historia.com/api/v1/oauth/tokens/by-third-party-code/{thirdPartyCode}
  • Auth: none declared

Path parameters

thirdPartyCodestring uuid required

UUIDv7 one-time exchange code returned by the OAuth token endpoint.

Response

Access token returned successfully for a valid third-party exchange code.

access_tokenstring required

The issued Aura Historia access token (plaintext bearer value).

token_type'BEARER' required

Token type returned for Aura Historia access tokens.

expires_ininteger nullable

Seconds until the access token expires. null when the token does not expire.

scopestring required

Space-separated list of scopes granted to the access token.

third_party_exchange_codestring uuid

Optional one-time exchange code returned by POST /api/v1/oauth/token. It can be redeemed once via GET /api/v1/oauth/tokens/by-third-party-code/{thirdPartyCode} within 60 seconds to obtain the same access token.

Example response

{
  "access_token": "aurahistoria_abcdefghijk_verylongtokenvalue",
  "token_type": "BEARER",
  "scope": "product-listings:write",
  "third_party_exchange_code": "01970f22-2bf0-7000-8000-000000000099"
}

Changes

  • 999eda3fdd63Revision changes
    • breaking

      removed the required property / from the response with the status

    • breaking

      removed the required property / from the response with the status

    • info

      added the required property / to the response with the status

    • info

      added the required property / to the response with the status