com.amazonaws.services.ssooidc

Interface AWSSSOOIDCAsync

All Superinterfaces:

AWSSSOOIDC

All Known Implementing Classes:

AbstractAWSSSOOIDCAsync, AWSSSOOIDCAsyncClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSOOIDCAsync
extends AWSSSOOIDC

Interface for accessing SSO OIDC asynchronously. Each asynchronous method will return a Java Future object representing the asynchronous operation; overloads which accept an AsyncHandler can be used to receive notification when an asynchronous operation completes.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSSOOIDCAsync instead.

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Field Summary

Fields inherited from interface com.amazonaws.services.ssooidc.AWSSSOOIDC

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
Future<CreateTokenResult>	createTokenAsync(CreateTokenRequest createTokenRequest) Creates and returns an access token for the authorized client.
Future<CreateTokenResult>	createTokenAsync(CreateTokenRequest createTokenRequest, AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler) Creates and returns an access token for the authorized client.
Future<RegisterClientResult>	registerClientAsync(RegisterClientRequest registerClientRequest) Registers a client with AWS SSO.
Future<RegisterClientResult>	registerClientAsync(RegisterClientRequest registerClientRequest, AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler) Registers a client with AWS SSO.
Future<StartDeviceAuthorizationResult>	startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest) Initiates device authorization by requesting a pair of verification codes from the authorization service.
Future<StartDeviceAuthorizationResult>	startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest, AsyncHandler<StartDeviceAuthorizationRequest,StartDeviceAuthorizationResult> asyncHandler) Initiates device authorization by requesting a pair of verification codes from the authorization service.

Methods inherited from interface com.amazonaws.services.ssooidc.AWSSSOOIDC

createToken, getCachedResponseMetadata, registerClient, shutdown, startDeviceAuthorization

Method Detail

createTokenAsync

Future<CreateTokenResult> createTokenAsync(CreateTokenRequest createTokenRequest)

Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.

Parameters:

createTokenRequest -

Returns:

A Java Future containing the result of the CreateToken operation returned by the service.

See Also:

AWS API Documentation

createTokenAsync

Future<CreateTokenResult> createTokenAsync(CreateTokenRequest createTokenRequest,
                                           AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler)

Creates and returns an access token for the authorized client. The access token issued will be used to fetch short-term credentials for the assigned roles in the AWS account.

Parameters:

createTokenRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the CreateToken operation returned by the service.

See Also:

AWS API Documentation

registerClientAsync

Future<RegisterClientResult> registerClientAsync(RegisterClientRequest registerClientRequest)

Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

Parameters:

registerClientRequest -

Returns:

A Java Future containing the result of the RegisterClient operation returned by the service.

See Also:

AWS API Documentation

registerClientAsync

Future<RegisterClientResult> registerClientAsync(RegisterClientRequest registerClientRequest,
                                                 AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler)

Registers a client with AWS SSO. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.

Parameters:

registerClientRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the RegisterClient operation returned by the service.

See Also:

AWS API Documentation

startDeviceAuthorizationAsync

Future<StartDeviceAuthorizationResult> startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest)

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Parameters:

startDeviceAuthorizationRequest -

Returns:

A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.

See Also:

AWS API Documentation

startDeviceAuthorizationAsync

Future<StartDeviceAuthorizationResult> startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest,
                                                                     AsyncHandler<StartDeviceAuthorizationRequest,StartDeviceAuthorizationResult> asyncHandler)

Initiates device authorization by requesting a pair of verification codes from the authorization service.

Parameters:

startDeviceAuthorizationRequest -

asyncHandler - Asynchronous callback handler for events in the lifecycle of the request. Users can provide an implementation of the callback methods in this interface to receive notification of successful or unsuccessful completion of the operation.

Returns:

A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.

See Also:

AWS API Documentation