@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSSOOIDCAsync extends AWSSSOOIDC
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.
IAM Identity Center OpenID Connect (OIDC) is a web service that enables a client (such as CLI or a native application) to register with IAM Identity Center. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with IAM Identity Center.
IAM Identity Center uses the sso and identitystore API namespaces.
Considerations for Using This Guide
Before you begin using this guide, we recommend that you first review the following important information about how the IAM Identity Center OIDC service works.
The IAM Identity Center 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 CLI.
With older versions of the CLI, the service only emits OIDC access tokens, so to obtain a new token, users must explicitly re-authenticate. To access the OIDC flow that supports token refresh and doesn’t require re-authentication, update to the latest CLI version (1.27.10 for CLI V1 and 2.9.0 for CLI V2) with support for OIDC token refresh and configurable IAM Identity Center session durations. For more information, see Configure Amazon Web Services access portal session duration .
The access tokens provided by this service grant access to all Amazon Web Services account entitlements assigned to an IAM Identity Center user, not just a particular application.
The documentation in this guide does not describe the mechanism to convert the access token into Amazon Web Services Auth (“sigv4”) credentials for use with IAM-protected Amazon Web Services service endpoints. For more information, see GetRoleCredentials in the IAM Identity Center Portal API Reference Guide.
For general information about IAM Identity Center, see What is IAM Identity Center? in the IAM Identity Center User Guide.
ENDPOINT_PREFIX| Modifier and Type | Method and Description |
|---|---|
Future<CreateTokenResult> |
createTokenAsync(CreateTokenRequest createTokenRequest)
Creates and returns access and refresh tokens for clients that are authenticated using client secrets.
|
Future<CreateTokenResult> |
createTokenAsync(CreateTokenRequest createTokenRequest,
AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler)
Creates and returns access and refresh tokens for clients that are authenticated using client secrets.
|
Future<CreateTokenWithIAMResult> |
createTokenWithIAMAsync(CreateTokenWithIAMRequest createTokenWithIAMRequest)
Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM
entities.
|
Future<CreateTokenWithIAMResult> |
createTokenWithIAMAsync(CreateTokenWithIAMRequest createTokenWithIAMRequest,
AsyncHandler<CreateTokenWithIAMRequest,CreateTokenWithIAMResult> asyncHandler)
Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM
entities.
|
Future<RegisterClientResult> |
registerClientAsync(RegisterClientRequest registerClientRequest)
Registers a client with IAM Identity Center.
|
Future<RegisterClientResult> |
registerClientAsync(RegisterClientRequest registerClientRequest,
AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler)
Registers a client with IAM Identity Center.
|
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.
|
createToken, createTokenWithIAM, getCachedResponseMetadata, registerClient, shutdown, startDeviceAuthorizationFuture<CreateTokenResult> createTokenAsync(CreateTokenRequest createTokenRequest)
Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access
token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs
using bearer authentication.
createTokenRequest - Future<CreateTokenResult> createTokenAsync(CreateTokenRequest createTokenRequest, AsyncHandler<CreateTokenRequest,CreateTokenResult> asyncHandler)
Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access
token can be used to fetch short-term credentials for the assigned AWS accounts or to access application APIs
using bearer authentication.
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.Future<CreateTokenWithIAMResult> createTokenWithIAMAsync(CreateTokenWithIAMRequest createTokenWithIAMRequest)
Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM
entities. The access token can be used to fetch short-term credentials for the assigned Amazon Web Services
accounts or to access application APIs using bearer authentication.
createTokenWithIAMRequest - Future<CreateTokenWithIAMResult> createTokenWithIAMAsync(CreateTokenWithIAMRequest createTokenWithIAMRequest, AsyncHandler<CreateTokenWithIAMRequest,CreateTokenWithIAMResult> asyncHandler)
Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM
entities. The access token can be used to fetch short-term credentials for the assigned Amazon Web Services
accounts or to access application APIs using bearer authentication.
createTokenWithIAMRequest - 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.Future<RegisterClientResult> registerClientAsync(RegisterClientRequest registerClientRequest)
Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
registerClientRequest - Future<RegisterClientResult> registerClientAsync(RegisterClientRequest registerClientRequest, AsyncHandler<RegisterClientRequest,RegisterClientResult> asyncHandler)
Registers a client with IAM Identity Center. This allows clients to initiate device authorization. The output should be persisted for reuse through many authentication requests.
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.Future<StartDeviceAuthorizationResult> startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest)
Initiates device authorization by requesting a pair of verification codes from the authorization service.
startDeviceAuthorizationRequest - Future<StartDeviceAuthorizationResult> startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest, AsyncHandler<StartDeviceAuthorizationRequest,StartDeviceAuthorizationResult> asyncHandler)
Initiates device authorization by requesting a pair of verification codes from the authorization service.
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.