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.

Amazon Web Services Single Sign On OpenID Connect (OIDC) is a web service that enables a client (such as Amazon Web Services CLI or a native application) to register with Amazon Web Services SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with Amazon Web Services SSO.

Although Amazon Web Services Single Sign-On was renamed, the sso and identitystore API namespaces will continue to retain their original name for backward compatibility purposes. For more information, see Amazon Web Services SSO rename.

Considerations for Using This Guide

Before you begin using this guide, we recommend that you first review the following important information about how the Amazon Web Services SSO OIDC service works.

• The Amazon Web Services SSO OIDC service currently implements only the portions of the OAuth 2.0 Device Authorization Grant standard (https://tools.ietf.org/html/rfc8628) that are necessary to enable single sign-on authentication with the AWS CLI. Support for other OIDC flows frequently needed for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in future releases.

• The service emits only OIDC access tokens, such that obtaining a new token (For example, token refresh) requires explicit user re-authentication.

• The access tokens provided by this service grant access to all AWS account entitlements assigned to an Amazon Web Services SSO user, not just a particular application.

• The documentation in this guide does not describe the mechanism to convert the access token into AWS Auth (“sigv4”) credentials for use with IAM-protected AWS service endpoints. For more information, see GetRoleCredentials in the Amazon Web Services SSO Portal API Reference Guide.

For general information about Amazon Web Services SSO, see What is Amazon Web Services SSO? in the Amazon Web Services SSO User Guide.

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 Amazon Web Services SSO.
Future<RegisterClientResult>	registerClientAsync(RegisterClientRequest registerClientRequest, AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler) Registers a client with Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services 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