software.amazon.awssdk.services.ssooidc

Interface SsoOidcAsyncClient

All Superinterfaces:

AutoCloseable, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
public interface SsoOidcAsyncClient
extends SdkClient

Service client for accessing SSO OIDC asynchronously. This can be created using the static builder() method.

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static SsoOidcAsyncClientBuilder	builder() Create a builder that can be used to configure and create a SsoOidcAsyncClient.
static SsoOidcAsyncClient	create() Create a SsoOidcAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CompletableFuture<CreateTokenResponse>	createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest) Creates and returns an access token for the authorized client.
default CompletableFuture<CreateTokenResponse>	createToken(CreateTokenRequest createTokenRequest) Creates and returns an access token for the authorized client.
default CompletableFuture<RegisterClientResponse>	registerClient(Consumer<RegisterClientRequest.Builder> registerClientRequest) Registers a client with AWS SSO.
default CompletableFuture<RegisterClientResponse>	registerClient(RegisterClientRequest registerClientRequest) Registers a client with AWS SSO.
default CompletableFuture<StartDeviceAuthorizationResponse>	startDeviceAuthorization(Consumer<StartDeviceAuthorizationRequest.Builder> startDeviceAuthorizationRequest) Initiates device authorization by requesting a pair of verification codes from the authorization service.
default CompletableFuture<StartDeviceAuthorizationResponse>	startDeviceAuthorization(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest) Initiates device authorization by requesting a pair of verification codes from the authorization service.

Methods inherited from interface software.amazon.awssdk.core.SdkClient

serviceName

Methods inherited from interface software.amazon.awssdk.utils.SdkAutoCloseable

close

Field Detail

SERVICE_NAME

static final String SERVICE_NAME

See Also:

Constant Field Values

Method Detail

create

static SsoOidcAsyncClient create()

Create a SsoOidcAsyncClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.

builder

static SsoOidcAsyncClientBuilder builder()

Create a builder that can be used to configure and create a SsoOidcAsyncClient.

createToken

default CompletableFuture<CreateTokenResponse> createToken(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.

Parameters:

createTokenRequest -

Returns:

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.

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

See Also:

AWS API Documentation

createToken

default CompletableFuture<CreateTokenResponse> createToken(Consumer<CreateTokenRequest.Builder> 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.

This is a convenience which creates an instance of the CreateTokenRequest.Builder avoiding the need to create one manually via CreateTokenRequest.builder()

Parameters:

createTokenRequest - A Consumer that will call methods on CreateTokenRequest.Builder to create a request.

Returns:

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.

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

See Also:

AWS API Documentation

registerClient

default CompletableFuture<RegisterClientResponse> registerClient(RegisterClientRequest registerClientRequest)

Registers a client with AWS 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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

registerClient

default CompletableFuture<RegisterClientResponse> registerClient(Consumer<RegisterClientRequest.Builder> registerClientRequest)

Registers a client with AWS SSO. 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 RegisterClientRequest.Builder avoiding the need to create one manually via RegisterClientRequest.builder()

Parameters:

registerClientRequest - A Consumer that will call methods on RegisterClientRequest.Builder to create a request.

Returns:

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.

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

See Also:

AWS API Documentation

startDeviceAuthorization

default CompletableFuture<StartDeviceAuthorizationResponse> startDeviceAuthorization(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.
The CompletableFuture returned by this method can be completed exceptionally with the following exceptions.

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

See Also:

AWS API Documentation

startDeviceAuthorization

default CompletableFuture<StartDeviceAuthorizationResponse> startDeviceAuthorization(Consumer<StartDeviceAuthorizationRequest.Builder> startDeviceAuthorizationRequest)

Initiates device authorization by requesting a pair of verification codes from the authorization service.

This is a convenience which creates an instance of the StartDeviceAuthorizationRequest.Builder avoiding the need to create one manually via StartDeviceAuthorizationRequest.builder()

Parameters:

startDeviceAuthorizationRequest - A Consumer that will call methods on StartDeviceAuthorizationRequest.Builder to create a request.

Returns:

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.

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

See Also:

AWS API Documentation