Developer Documentation
Exchange Token Exchange
Released in v7.0.0Exchanges incoming token based on the spec and current client authorization data.
Request
URLURL
https://{api_host}/rest/vcenter/tokenservice/token-exchange
Request Body
Request Body
Contains
ExchangeRequestBody
of type application/json
(required)
{
"spec": {
"grant_type": "string",
"subject_token": "string",
"subject_token_type": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | TokenExchangeExchangeSpec |
TokenExchange.ExchangeSpec structure contains arguments that define exchange process. |
Response
Response
Response BodyResponse Body
200 OK returns
ExchangeResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: TokenExchange.Info structure that contains new token.
{
"value": {
"access_token": "string",
"expires_in": 0,
"issued_token_type": "string",
"refresh_token": "string",
"scope": "string",
"token_type": "string"
}
}| Property Name | Type | Description |
|---|---|---|
| value | TokenExchangeInfo |
TokenExchange.Info structure that contains new token. |
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | Error | com.vmware.vapi.std.errors.invalid_request : The request cannot be fulfilled due to bad syntax. | com.vmware.vcenter.tokenservice.invalid_request : The request cannot be fulfilled due to bad syntax. | com.vmware.vcenter.tokenservice.invalid_grant : provided authorization grant (e.g., authorization code, resource owner credentials) or refresh token is invalid, expired, revoked, does not match the redirection URI used in the authorization request, or was issued to another client. | com.vmware.vcenter.tokenservice.invalid_scope : If the server is unwilling or unable to issue a token for all the target services indicated by the TokenExchange.ExchangeSpec.resource or TokenExchange.ExchangeSpec.audience parameters. |
| 401 | Error | com.vmware.vapi.std.errors.unauthorized : if authorization is not given to a caller. |
| default | Error | Not available |
