software.amazon.awssdk.services.ssooidc

Interface SsoOidcClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

@Generated(value="software.amazon.awssdk:codegen")
 @ThreadSafe
public interface SsoOidcClient
extends AwsClient

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

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.

• 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 AWS CLI. Support for other OIDC flows frequently needed for native applications, such as Authorization Code Flow (+ PKCE), will be addressed in future releases.

• The service emits only OIDC access tokens, such that obtaining a new token (For example, token refresh) requires explicit user re-authentication.

• The access tokens provided by this service grant access to all AWS 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 AWS Auth (“sigv4”) credentials for use with IAM-protected AWS 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.

Field Summary

Fields

Modifier and Type	Field and Description
static String	SERVICE_METADATA_ID Value for looking up the service's metadata from the ServiceMetadataProvider.
static String	SERVICE_NAME

Method Summary

Modifier and Type	Method and Description
static SsoOidcClientBuilder	builder() Create a builder that can be used to configure and create a SsoOidcClient.
static SsoOidcClient	create() Create a SsoOidcClient with the region loaded from the DefaultAwsRegionProviderChain and credentials loaded from the DefaultCredentialsProvider.
default CreateTokenResponse	createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest) Creates and returns an access token for the authorized client.
default CreateTokenResponse	createToken(CreateTokenRequest createTokenRequest) Creates and returns an access token for the authorized client.
default RegisterClientResponse	registerClient(Consumer<RegisterClientRequest.Builder> registerClientRequest) Registers a client with IAM Identity Center.
default RegisterClientResponse	registerClient(RegisterClientRequest registerClientRequest) Registers a client with IAM Identity Center.
default SsoOidcServiceClientConfiguration	serviceClientConfiguration()
static ServiceMetadata	serviceMetadata()
default StartDeviceAuthorizationResponse	startDeviceAuthorization(Consumer<StartDeviceAuthorizationRequest.Builder> startDeviceAuthorizationRequest) Initiates device authorization by requesting a pair of verification codes from the authorization service.
default 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

SERVICE_METADATA_ID

static final String SERVICE_METADATA_ID

Value for looking up the service's metadata from the ServiceMetadataProvider.

See Also:

Constant Field Values

Method Detail

createToken

default CreateTokenResponse createToken(CreateTokenRequest createTokenRequest)
                                 throws InvalidRequestException,
                                        InvalidClientException,
                                        InvalidGrantException,
                                        UnauthorizedClientException,
                                        UnsupportedGrantTypeException,
                                        InvalidScopeException,
                                        AuthorizationPendingException,
                                        SlowDownException,
                                        AccessDeniedException,
                                        ExpiredTokenException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SsoOidcException

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:

Result of the CreateToken operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

createToken

default CreateTokenResponse createToken(Consumer<CreateTokenRequest.Builder> createTokenRequest)
                                 throws InvalidRequestException,
                                        InvalidClientException,
                                        InvalidGrantException,
                                        UnauthorizedClientException,
                                        UnsupportedGrantTypeException,
                                        InvalidScopeException,
                                        AuthorizationPendingException,
                                        SlowDownException,
                                        AccessDeniedException,
                                        ExpiredTokenException,
                                        InternalServerException,
                                        AwsServiceException,
                                        SdkClientException,
                                        SsoOidcException

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:

Result of the CreateToken operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

registerClient

default RegisterClientResponse registerClient(RegisterClientRequest registerClientRequest)
                                       throws InvalidRequestException,
                                              InvalidScopeException,
                                              InvalidClientMetadataException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SsoOidcException

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.

Parameters:

registerClientRequest -

Returns:

Result of the RegisterClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

registerClient

default RegisterClientResponse registerClient(Consumer<RegisterClientRequest.Builder> registerClientRequest)
                                       throws InvalidRequestException,
                                              InvalidScopeException,
                                              InvalidClientMetadataException,
                                              InternalServerException,
                                              AwsServiceException,
                                              SdkClientException,
                                              SsoOidcException

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 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:

Result of the RegisterClient operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

startDeviceAuthorization

default StartDeviceAuthorizationResponse startDeviceAuthorization(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidClientException,
                                                                  UnauthorizedClientException,
                                                                  SlowDownException,
                                                                  InternalServerException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SsoOidcException

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

Parameters:

startDeviceAuthorizationRequest -

Returns:

Result of the StartDeviceAuthorization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

startDeviceAuthorization

default StartDeviceAuthorizationResponse startDeviceAuthorization(Consumer<StartDeviceAuthorizationRequest.Builder> startDeviceAuthorizationRequest)
                                                           throws InvalidRequestException,
                                                                  InvalidClientException,
                                                                  UnauthorizedClientException,
                                                                  SlowDownException,
                                                                  InternalServerException,
                                                                  AwsServiceException,
                                                                  SdkClientException,
                                                                  SsoOidcException

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:

Result of the StartDeviceAuthorization operation returned by the service.

Throws:

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.

AwsServiceException

See Also:

AWS API Documentation

create

static SsoOidcClient create()

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

builder

static SsoOidcClientBuilder builder()

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

serviceMetadata

static ServiceMetadata serviceMetadata()

serviceClientConfiguration

default SsoOidcServiceClientConfiguration serviceClientConfiguration()

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient