token exchange
Download Spectoken
string
required
Token to exchange to a PrivX access token
scope
string
Access Token Scope.
- Example
- "privx-user connections-manual"
client_id
string
OAUTH client ID
- Example
- "privx-ui"
Request
{
"token": "string",
"scope": "privx-user connections-manual",
"client_id": "privx-ui"
}
Response
Successful response, returns JSON object
{
"access_token": "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0=.eyJhdWQiOiJwcml2eC11aSIsImV4cCI6MTUyMjgzNjAxNSwiaWF0IjoxNTIyODM1NzE1LCJpc3MiOiJvYW0uYXV0aC5zc2guY29tIiwiZG9tYWluIjoicHJpdngtdWkiLCJwZXJtaXNzaW9ucyI6InByaXZ4LWFkbWluLHByaXZ4LXVzZXIiLCJzZXNzaW9uaWQiOiI4MWI2NjNiOC02Zjc5LTQ3ZjctNzY0Yy03MTdmMGEwNjk0MjYiLCJ1c2VyaWQiOiJhOGMyNjM5NS0zMmZjLTQxMjctYmRiNy04MDllZThhMjAzZjIifQ==.JM6RrCYg9djDnoJtRkAMAKvkM2Zm9dYuxgN1zZA7G1-XTCc4Iub_y6lKdhHnoRm_hUwW6QtRWm8IlAUayqs4Aw",
"token_type": "bearer",
"expires_in": 300,
"refresh_token": "I7SNNZH4GLZNCOIV7D6DKULPFXBWBD4TTZJ5KQDCO3N2W7D562WSE5QWSNQFO7OTG5VRGPDU73SEUR5NVTXLPNDV6TQD6OH6V7S3JNWNFSPZ3ARSSJKJO6MSPVHRY3OFFXN4YLRDZPODQCDW6UL27PLR2YWUOUHF5WBIKZVDR4H5R4VQSPPKBBJC4GWJ3XAPWZL4DBVT6YH6PVBWMOKJHDO66577OBJVOOKWAVY7JEFQTTZNRTNDXPHI42AGHMCNWHFBSG63PXSMO67YQJBC55CHAQQI3XS3ZUCQ",
"scope": "privx-user connections-manual"
}
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Empty response
Bad request
{
"error": "invalid_request",
"error_description": "string"
}
Internal server error
{
"error": "invalid_request",
"error_description": "string"
}
error
string
required
Standard error code denoting the error type
- Enum
-
- invalid_request
- invalid_client
- invalid_grant
- unauthorized_client
- unsupported_grant_type
- invalid_scope
error_description
string
Textual, human readable error message
error
string
required
Standard error code denoting the error type
- Enum
-
- invalid_request
- invalid_client
- invalid_grant
- unauthorized_client
- unsupported_grant_type
- invalid_scope
error_description
string
Textual, human readable error message
access_token
string
OAuth2 access token
- Example
- "eyJhbGciOiJFZDI1NTE5IiwidHlwIjoiSldUIn0=.eyJhdWQiOiJwcml2eC11aSIsImV4cCI6MTUyMjgzNjAxNSwiaWF0IjoxNTIyODM1NzE1LCJpc3MiOiJvYW0uYXV0aC5zc2guY29tIiwiZG9tYWluIjoicHJpdngtdWkiLCJwZXJtaXNzaW9ucyI6InByaXZ4LWFkbWluLHByaXZ4LXVzZXIiLCJzZXNzaW9uaWQiOiI4MWI2NjNiOC02Zjc5LTQ3ZjctNzY0Yy03MTdmMGEwNjk0MjYiLCJ1c2VyaWQiOiJhOGMyNjM5NS0zMmZjLTQxMjctYmRiNy04MDllZThhMjAzZjIifQ==.JM6RrCYg9djDnoJtRkAMAKvkM2Zm9dYuxgN1zZA7G1-XTCc4Iub_y6lKdhHnoRm_hUwW6QtRWm8IlAUayqs4Aw"
token_type
string
Token type
- Example
- "bearer"
expires_in
int
Token expiration time in seconds.
- Example
- 300
refresh_token
string
Refresh token.
- Example
- "I7SNNZH4GLZNCOIV7D6DKULPFXBWBD4TTZJ5KQDCO3N2W7D562WSE5QWSNQFO7OTG5VRGPDU73SEUR5NVTXLPNDV6TQD6OH6V7S3JNWNFSPZ3ARSSJKJO6MSPVHRY3OFFXN4YLRDZPODQCDW6UL27PLR2YWUOUHF5WBIKZVDR4H5R4VQSPPKBBJC4GWJ3XAPWZL4DBVT6YH6PVBWMOKJHDO66577OBJVOOKWAVY7JEFQTTZNRTNDXPHI42AGHMCNWHFBSG63PXSMO67YQJBC55CHAQQI3XS3ZUCQ"
scope
string
Access Token Scope.
- Example
- "privx-user connections-manual"
Was this page helpful?