com.amazonaws.services.ssooidc.AWSSSOOIDCAsync Maven / Gradle / Ivy
Show all versions of aws-java-sdk-ssooidc Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.ssooidc;
import javax.annotation.Generated;
import com.amazonaws.services.ssooidc.model.*;
/**
* Interface for accessing SSO OIDC asynchronously. Each asynchronous method will return a Java Future object
* representing the asynchronous operation; overloads which accept an {@code 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
* {@link com.amazonaws.services.ssooidc.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.
*
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSOOIDCAsync extends AWSSSOOIDC {
/**
*
* 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.
*
*
* @param createTokenRequest
* @return A Java Future containing the result of the CreateToken operation returned by the service.
* @sample AWSSSOOIDCAsync.CreateToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createTokenRequest
* @param 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.
* @return A Java Future containing the result of the CreateToken operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.CreateToken
* @see AWS API
* Documentation
*/
java.util.concurrent.Future createTokenAsync(CreateTokenRequest createTokenRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param createTokenWithIAMRequest
* @return A Java Future containing the result of the CreateTokenWithIAM operation returned by the service.
* @sample AWSSSOOIDCAsync.CreateTokenWithIAM
* @see AWS
* API Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param createTokenWithIAMRequest
* @param 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.
* @return A Java Future containing the result of the CreateTokenWithIAM operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.CreateTokenWithIAM
* @see AWS
* API Documentation
*/
java.util.concurrent.Future createTokenWithIAMAsync(CreateTokenWithIAMRequest createTokenWithIAMRequest,
com.amazonaws.handlers.AsyncHandler 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.
*
*
* @param registerClientRequest
* @return A Java Future containing the result of the RegisterClient operation returned by the service.
* @sample AWSSSOOIDCAsync.RegisterClient
* @see AWS API
* Documentation
*/
java.util.concurrent.Future 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.
*
*
* @param registerClientRequest
* @param 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.
* @return A Java Future containing the result of the RegisterClient operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.RegisterClient
* @see AWS API
* Documentation
*/
java.util.concurrent.Future registerClientAsync(RegisterClientRequest registerClientRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
/**
*
* Initiates device authorization by requesting a pair of verification codes from the authorization service.
*
*
* @param startDeviceAuthorizationRequest
* @return A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.
* @sample AWSSSOOIDCAsync.StartDeviceAuthorization
* @see AWS API Documentation
*/
java.util.concurrent.Future startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest);
/**
*
* Initiates device authorization by requesting a pair of verification codes from the authorization service.
*
*
* @param startDeviceAuthorizationRequest
* @param 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.
* @return A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.
* @sample AWSSSOOIDCAsyncHandler.StartDeviceAuthorization
* @see AWS API Documentation
*/
java.util.concurrent.Future startDeviceAuthorizationAsync(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest,
com.amazonaws.handlers.AsyncHandler asyncHandler);
}