software.amazon.awssdk.services.ssooidc.SsoOidcAsyncClient Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of ssooidc Show documentation
Show all versions of ssooidc Show documentation
The AWS Java SDK for SSO OIDC module holds the client classes that are used for
communicating with SSO OIDC.
The newest version!
/*
* Copyright 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 software.amazon.awssdk.services.ssooidc;
import java.util.concurrent.CompletableFuture;
import java.util.function.Consumer;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.annotations.SdkPublicApi;
import software.amazon.awssdk.annotations.ThreadSafe;
import software.amazon.awssdk.awscore.AwsClient;
import software.amazon.awssdk.services.ssooidc.model.CreateTokenRequest;
import software.amazon.awssdk.services.ssooidc.model.CreateTokenResponse;
import software.amazon.awssdk.services.ssooidc.model.CreateTokenWithIamRequest;
import software.amazon.awssdk.services.ssooidc.model.CreateTokenWithIamResponse;
import software.amazon.awssdk.services.ssooidc.model.RegisterClientRequest;
import software.amazon.awssdk.services.ssooidc.model.RegisterClientResponse;
import software.amazon.awssdk.services.ssooidc.model.StartDeviceAuthorizationRequest;
import software.amazon.awssdk.services.ssooidc.model.StartDeviceAuthorizationResponse;
/**
* Service client for accessing SSO OIDC asynchronously. This can be created using the static {@link #builder()}
* method.The asynchronous client performs non-blocking I/O when configured with any {@code SdkAsyncHttpClient}
* supported in the SDK. However, full non-blocking is not guaranteed as the async client may perform blocking calls in
* some cases such as credentials retrieval and endpoint discovery as part of the async API call.
*
*
* 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("software.amazon.awssdk:codegen")
@SdkPublicApi
@ThreadSafe
public interface SsoOidcAsyncClient extends AwsClient {
String SERVICE_NAME = "sso-oauth";
/**
* Value for looking up the service's metadata from the
* {@link software.amazon.awssdk.regions.ServiceMetadataProvider}.
*/
String SERVICE_METADATA_ID = "oidc";
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidClientException Indicates that the
clientId or clientSecret in the
* request is invalid. For example, this can occur when a client sends an incorrect clientId or
* an expired clientSecret.
* - InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client
* makes a CreateToken request with an invalid grant type.
* - UnauthorizedClientException Indicates that the client is not currently authorized to make the
* request. This can happen when a
clientId is not issued for a public client.
* - UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the
* service.
* - InvalidScopeException Indicates that the scope provided in the request is invalid.
* - AuthorizationPendingException Indicates that a request to authorize a client with an access user
* session token is pending.
* - SlowDownException Indicates that the client is making the request too frequently and is more than the
* service can handle.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ExpiredTokenException Indicates that the token issued by the service is expired and is no longer
* valid.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.CreateToken
* @see AWS API
* Documentation
*/
default CompletableFuture createToken(CreateTokenRequest createTokenRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link CreateTokenRequest.Builder} avoiding the need to
* create one manually via {@link CreateTokenRequest#builder()}
*
*
* @param createTokenRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ssooidc.model.CreateTokenRequest.Builder} to create a request.
* @return A Java Future containing the result of the CreateToken operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidClientException Indicates that the
clientId or clientSecret in the
* request is invalid. For example, this can occur when a client sends an incorrect clientId or
* an expired clientSecret.
* - InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client
* makes a CreateToken request with an invalid grant type.
* - UnauthorizedClientException Indicates that the client is not currently authorized to make the
* request. This can happen when a
clientId is not issued for a public client.
* - UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the
* service.
* - InvalidScopeException Indicates that the scope provided in the request is invalid.
* - AuthorizationPendingException Indicates that a request to authorize a client with an access user
* session token is pending.
* - SlowDownException Indicates that the client is making the request too frequently and is more than the
* service can handle.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ExpiredTokenException Indicates that the token issued by the service is expired and is no longer
* valid.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.CreateToken
* @see AWS API
* Documentation
*/
default CompletableFuture createToken(Consumer createTokenRequest) {
return createToken(CreateTokenRequest.builder().applyMutation(createTokenRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidClientException Indicates that the
clientId or clientSecret in the
* request is invalid. For example, this can occur when a client sends an incorrect clientId or
* an expired clientSecret.
* - InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client
* makes a CreateToken request with an invalid grant type.
* - UnauthorizedClientException Indicates that the client is not currently authorized to make the
* request. This can happen when a
clientId is not issued for a public client.
* - UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the
* service.
* - InvalidScopeException Indicates that the scope provided in the request is invalid.
* - AuthorizationPendingException Indicates that a request to authorize a client with an access user
* session token is pending.
* - SlowDownException Indicates that the client is making the request too frequently and is more than the
* service can handle.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ExpiredTokenException Indicates that the token issued by the service is expired and is no longer
* valid.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - InvalidRequestRegionException Indicates that a token provided as input to the request was issued by
* and is only usable by calling IAM Identity Center endpoints in another region.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.CreateTokenWithIAM
* @see AWS
* API Documentation
*/
default CompletableFuture createTokenWithIAM(CreateTokenWithIamRequest createTokenWithIamRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link CreateTokenWithIamRequest.Builder} avoiding the
* need to create one manually via {@link CreateTokenWithIamRequest#builder()}
*
*
* @param createTokenWithIamRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ssooidc.model.CreateTokenWithIamRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the CreateTokenWithIAM operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidClientException Indicates that the
clientId or clientSecret in the
* request is invalid. For example, this can occur when a client sends an incorrect clientId or
* an expired clientSecret.
* - InvalidGrantException Indicates that a request contains an invalid grant. This can occur if a client
* makes a CreateToken request with an invalid grant type.
* - UnauthorizedClientException Indicates that the client is not currently authorized to make the
* request. This can happen when a
clientId is not issued for a public client.
* - UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the
* service.
* - InvalidScopeException Indicates that the scope provided in the request is invalid.
* - AuthorizationPendingException Indicates that a request to authorize a client with an access user
* session token is pending.
* - SlowDownException Indicates that the client is making the request too frequently and is more than the
* service can handle.
* - AccessDeniedException You do not have sufficient access to perform this action.
* - ExpiredTokenException Indicates that the token issued by the service is expired and is no longer
* valid.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - InvalidRequestRegionException Indicates that a token provided as input to the request was issued by
* and is only usable by calling IAM Identity Center endpoints in another region.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.CreateTokenWithIAM
* @see AWS
* API Documentation
*/
default CompletableFuture createTokenWithIAM(
Consumer createTokenWithIamRequest) {
return createTokenWithIAM(CreateTokenWithIamRequest.builder().applyMutation(createTokenWithIamRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidScopeException Indicates that the scope provided in the request is invalid.
* - InvalidClientMetadataException Indicates that the client information sent in the request during
* registration is invalid.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - InvalidRedirectUriException Indicates that one or more redirect URI in the request is not supported
* for this operation.
* - UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the
* service.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.RegisterClient
* @see AWS API
* Documentation
*/
default CompletableFuture registerClient(RegisterClientRequest registerClientRequest) {
throw new UnsupportedOperationException();
}
/**
*
* 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.
*
*
*
* This is a convenience which creates an instance of the {@link RegisterClientRequest.Builder} avoiding the need to
* create one manually via {@link RegisterClientRequest#builder()}
*
*
* @param registerClientRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ssooidc.model.RegisterClientRequest.Builder} to create a request.
* @return A Java Future containing the result of the RegisterClient operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidScopeException Indicates that the scope provided in the request is invalid.
* - InvalidClientMetadataException Indicates that the client information sent in the request during
* registration is invalid.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - InvalidRedirectUriException Indicates that one or more redirect URI in the request is not supported
* for this operation.
* - UnsupportedGrantTypeException Indicates that the grant type in the request is not supported by the
* service.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.RegisterClient
* @see AWS API
* Documentation
*/
default CompletableFuture registerClient(Consumer registerClientRequest) {
return registerClient(RegisterClientRequest.builder().applyMutation(registerClientRequest).build());
}
/**
*
* 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.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidClientException Indicates that the
clientId or clientSecret in the
* request is invalid. For example, this can occur when a client sends an incorrect clientId or
* an expired clientSecret.
* - UnauthorizedClientException Indicates that the client is not currently authorized to make the
* request. This can happen when a
clientId is not issued for a public client.
* - SlowDownException Indicates that the client is making the request too frequently and is more than the
* service can handle.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.StartDeviceAuthorization
* @see AWS API Documentation
*/
default CompletableFuture startDeviceAuthorization(
StartDeviceAuthorizationRequest startDeviceAuthorizationRequest) {
throw new UnsupportedOperationException();
}
/**
*
* Initiates device authorization by requesting a pair of verification codes from the authorization service.
*
*
*
* This is a convenience which creates an instance of the {@link StartDeviceAuthorizationRequest.Builder} avoiding
* the need to create one manually via {@link StartDeviceAuthorizationRequest#builder()}
*
*
* @param startDeviceAuthorizationRequest
* A {@link Consumer} that will call methods on
* {@link software.amazon.awssdk.services.ssooidc.model.StartDeviceAuthorizationRequest.Builder} to create a
* request.
* @return A Java Future containing the result of the StartDeviceAuthorization operation returned by the service.
* The CompletableFuture returned by this method can be completed exceptionally with the following
* exceptions. The exception returned is wrapped with CompletionException, so you need to invoke
* {@link Throwable#getCause} to retrieve the underlying exception.
*
* - InvalidRequestException Indicates that something is wrong with the input to the request. For example,
* a required parameter might be missing or out of range.
* - InvalidClientException Indicates that the
clientId or clientSecret in the
* request is invalid. For example, this can occur when a client sends an incorrect clientId or
* an expired clientSecret.
* - UnauthorizedClientException Indicates that the client is not currently authorized to make the
* request. This can happen when a
clientId is not issued for a public client.
* - SlowDownException Indicates that the client is making the request too frequently and is more than the
* service can handle.
* - InternalServerException Indicates that an error from the service occurred while trying to process a
* request.
* - SdkException Base class for all exceptions that can be thrown by the SDK (both service and client).
* Can be used for catch all scenarios.
* - SdkClientException If any client side error occurs such as an IO related failure, failure to get
* credentials, etc.
* - SsoOidcException Base class for all service exceptions. Unknown exceptions will be thrown as an
* instance of this type.
*
* @sample SsoOidcAsyncClient.StartDeviceAuthorization
* @see AWS API Documentation
*/
default CompletableFuture startDeviceAuthorization(
Consumer startDeviceAuthorizationRequest) {
return startDeviceAuthorization(StartDeviceAuthorizationRequest.builder().applyMutation(startDeviceAuthorizationRequest)
.build());
}
@Override
default SsoOidcServiceClientConfiguration serviceClientConfiguration() {
throw new UnsupportedOperationException();
}
/**
* Create a {@link SsoOidcAsyncClient} with the region loaded from the
* {@link software.amazon.awssdk.regions.providers.DefaultAwsRegionProviderChain} and credentials loaded from the
* {@link software.amazon.awssdk.auth.credentials.DefaultCredentialsProvider}.
*/
static SsoOidcAsyncClient create() {
return builder().build();
}
/**
* Create a builder that can be used to configure and create a {@link SsoOidcAsyncClient}.
*/
static SsoOidcAsyncClientBuilder builder() {
return new DefaultSsoOidcAsyncClientBuilder();
}
}