v3

latestOpenAPI 3.0.02026-07-311784111.3 MB
Authentication
Public

Generates a token for a new subject id. This method can be used to switch between subaccounts.

📖 Related Articles:

Try in API console

get/public/exchange_token

Query parameters

refresh_tokenstring required
Example:1568800656974.1CWcuzUS.MGy49NK4hpTwvR1OYWfpqMEkH4T4oDg4tNIcrM7KdeyxXRcSFqiGzA_D4Cn7mqWocHmlS89FFmUYcmaN2H7lNKKTnhRg5EtrzsFCCiuyN0Wv9y-LbGLV3-Ojv_kbD50FoScQ8BDXS5b_w6Ir1MqEdQ3qFZ3MLcvlPiIgG2BqyJX3ybYnVpIlrVrrdYD1-lkjLcjxOBNJvvUKNUAzkQ

Refresh token

subject_idinteger required
Example:10

New subject id

scopestring

Optional scope override for the new session. Cannot exceed caller's permissions. Supports session scope for direct session creation during token exchange.

Response

Success response

jsonrpc'2.0' required

The JSON-RPC version (2.0)

idinteger

The id that was sent in the request

Example response

{
  "result": {
    "access_token": "843SehgeX5n6XxEU4XbABx4Cny5Akai5iHiJePTsvUw7",
    "expires_in": 315360000,
    "refresh_token": "6faf8L36JdaSqsjCEEiwqifPpj6JB18RWwiWHrsGTZ91"
  }
}