VMware vSphere Automation SDK for .NET 7.0.0.1
vmware::vcenter::tokenservice::TokenExchange Interface Reference

The TokenExchange interface provides possibility to exchange between different tokens types. More...

Inherited by vmware::vcenter::tokenservice::TokenExchangeStub.

List of all members.

Public Member Functions

vmware.vcenter.tokenservice.TokenExchangeTypes.Info Exchange (vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec spec)
 Exchanges incoming token based on the spec and current client authorization data.
vmware.vcenter.tokenservice.TokenExchangeTypes.Info Exchange (vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Exchanges incoming token based on the spec and current client authorization data.
global::System.Threading.Tasks.Task
< vmware.vcenter.tokenservice.TokenExchangeTypes.Info
ExchangeAsync (vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec spec)
 Exchanges incoming token based on the spec and current client authorization data.
global::System.Threading.Tasks.Task
< vmware.vcenter.tokenservice.TokenExchangeTypes.Info
ExchangeAsync (vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec spec, global::System.Action< vmware.vapi.std.Progress > _progress, vmware.vapi.bindings.client.InvocationConfig _invocationConfig)
 Exchanges incoming token based on the spec and current client authorization data.

Detailed Description

The TokenExchange interface provides possibility to exchange between different tokens types.

Implementation of "OAuth 2.0 Token Exchange" standard (https://tools.ietf.org/html/draft-ietf-oauth-token-exchange-12).


Member Function Documentation

Exchanges incoming token based on the spec and current client authorization data.

Exceptions:
InvalidGrantprovided 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.
InvalidScopeIf 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.
vmware.vapi.std.errors.Unauthorizedif authorization is not given to a caller.
Parameters:
specTokenExchange.ExchangeSpec class contains arguments that define exchange process.
Returns:
TokenExchange.Info class that contains new token.

Implemented in vmware::vcenter::tokenservice::TokenExchangeStub.

vmware.vcenter.tokenservice.TokenExchangeTypes.Info vmware::vcenter::tokenservice::TokenExchange::Exchange ( vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Exchanges incoming token based on the spec and current client authorization data.

Exceptions:
InvalidGrantprovided 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.
InvalidScopeIf 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.
vmware.vapi.std.errors.Unauthorizedif authorization is not given to a caller.
Parameters:
specTokenExchange.ExchangeSpec class contains arguments that define exchange process.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
TokenExchange.Info class that contains new token.

Implemented in vmware::vcenter::tokenservice::TokenExchangeStub.

global::System.Threading.Tasks.Task<vmware.vcenter.tokenservice.TokenExchangeTypes.Info> vmware::vcenter::tokenservice::TokenExchange::ExchangeAsync ( vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec  spec)

Exchanges incoming token based on the spec and current client authorization data.

Exceptions:
InvalidGrantprovided 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.
InvalidScopeIf 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.
vmware.vapi.std.errors.Unauthorizedif authorization is not given to a caller.
Parameters:
specTokenExchange.ExchangeSpec class contains arguments that define exchange process.
Returns:
TokenExchange.Info class that contains new token.

Implemented in vmware::vcenter::tokenservice::TokenExchangeStub.

global::System.Threading.Tasks.Task<vmware.vcenter.tokenservice.TokenExchangeTypes.Info> vmware::vcenter::tokenservice::TokenExchange::ExchangeAsync ( vmware.vcenter.tokenservice.TokenExchangeTypes.ExchangeSpec  spec,
global::System.Action< vmware.vapi.std.Progress >  _progress,
vmware.vapi.bindings.client.InvocationConfig  _invocationConfig 
)

Exchanges incoming token based on the spec and current client authorization data.

Exceptions:
InvalidGrantprovided 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.
InvalidScopeIf 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.
vmware.vapi.std.errors.Unauthorizedif authorization is not given to a caller.
Parameters:
specTokenExchange.ExchangeSpec class contains arguments that define exchange process.
_progressProgress notification call back
_invocationConfigConfiguration for the method invocation
Returns:
TokenExchange.Info class that contains new token.

Implemented in vmware::vcenter::tokenservice::TokenExchangeStub.


The documentation for this interface was generated from the following file: