com.vmware.vcenter.authentication

Interface Token

All Superinterfaces:

Service, TokenTypes

All Known Implementing Classes:

TokenStub

public interface Token
extends Service, TokenTypes

The Token interface provides operations for obtaining an access token.

Nested Class Summary

Nested classes/interfaces inherited from interface com.vmware.vcenter.authentication.TokenTypes

TokenTypes.IssueSpec

Field Summary

Fields inherited from interface com.vmware.vcenter.authentication.TokenTypes

_VAPI_SERVICE_ID

Method Summary

Modifier and Type	Method and Description
TokenInfo	issue(TokenTypes.IssueSpec spec) Provides a token endpoint as defined in RFC 6749.
void	issue(TokenTypes.IssueSpec spec, AsyncCallback<TokenInfo> asyncCallback) Provides a token endpoint as defined in RFC 6749.
void	issue(TokenTypes.IssueSpec spec, AsyncCallback<TokenInfo> asyncCallback, InvocationConfig invocationConfig) Provides a token endpoint as defined in RFC 6749.
TokenInfo	issue(TokenTypes.IssueSpec spec, InvocationConfig invocationConfig) Provides a token endpoint as defined in RFC 6749.

Method Detail

issue

TokenInfo issue(TokenTypes.IssueSpec spec)

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

Synchronous method overload. Result of the invocation will be reported as a method return value.

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

Returns:

TokenInfo class that contains a newly issued token.

Throws:

InvalidRequest - if TokenTypes.IssueSpec is missing a required property, includes an unsupported property value (other than TokenTypes.IssueSpec.getGrantType()).

InvalidGrant - 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.

InvalidScope - If the server is unwilling or unable to issue a token for all the target services indicated by the TokenTypes.IssueSpec.getResource() or TokenTypes.IssueSpec.getAudience() properties.

issue

TokenInfo issue(TokenTypes.IssueSpec spec,
                InvocationConfig invocationConfig)

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

Synchronous method overload. Result of the invocation will be reported as a method return value. Use invocationConfig to specify configuration for this particular invocation.

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

invocationConfig - Configuration for the method invocation.

Returns:

TokenInfo class that contains a newly issued token.

Throws:

InvalidRequest - if TokenTypes.IssueSpec is missing a required property, includes an unsupported property value (other than TokenTypes.IssueSpec.getGrantType()).

InvalidGrant - 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.

InvalidScope - If the server is unwilling or unable to issue a token for all the target services indicated by the TokenTypes.IssueSpec.getResource() or TokenTypes.IssueSpec.getAudience() properties.

issue

void issue(TokenTypes.IssueSpec spec,
           AsyncCallback<TokenInfo> asyncCallback)

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback.

Invocation Result:
TokenInfo class that contains a newly issued token.

Operation Errors:
InvalidRequest - if TokenTypes.IssueSpec is missing a required property, includes an unsupported property value (other than TokenTypes.IssueSpec.getGrantType()).
InvalidGrant - 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.
InvalidScope - If the server is unwilling or unable to issue a token for all the target services indicated by the TokenTypes.IssueSpec.getResource() or TokenTypes.IssueSpec.getAudience() properties.

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

issue

void issue(TokenTypes.IssueSpec spec,
           AsyncCallback<TokenInfo> asyncCallback,
           InvocationConfig invocationConfig)

Provides a token endpoint as defined in RFC 6749.

Supported grant types:

• urn:ietf:params:oauth:grant-type:token-exchange - Exchanges incoming token based on the spec and current client authorization data.

This method supercedes com.vmware.vcenter.tokenservice.TokenExchange#exchange. The REST rendering of the newer operation matches RFC8693's definition for both input and output of the method.

Asynchronous method overload. Result of the invocation will be reported via the specified asyncCallback. Use invocationConfig to specify configuration for this particular invocation.

Invocation Result:
TokenInfo class that contains a newly issued token.

Operation Errors:
InvalidRequest - if TokenTypes.IssueSpec is missing a required property, includes an unsupported property value (other than TokenTypes.IssueSpec.getGrantType()).
InvalidGrant - 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.
InvalidScope - If the server is unwilling or unable to issue a token for all the target services indicated by the TokenTypes.IssueSpec.getResource() or TokenTypes.IssueSpec.getAudience() properties.

Parameters:

spec - IssueSpec class containing arguments that define the exchange process.

asyncCallback - Receives the status (progress, result or error) of the operation invocation.

invocationConfig - Configuration for the method invocation.