/* * Copyright 2018-2023 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. *

*

*

* AWS IAM Identity Center (successor to AWS Single Sign-On) OpenID Connect (OIDC) is a web service that enables a * client (such as AWS 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. *

* *

* Although AWS 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 IAM Identity Center 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 IAM Identity Center OIDC service works. *

* *

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

* * @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 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. *

* * @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); /** *

* 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); }