Interface SsoOidcClient

All Superinterfaces:

AutoCloseable, AwsClient, SdkAutoCloseable, SdkClient

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

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

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.

API namespaces

IAM Identity Center uses the sso and identitystore API namespaces. IAM Identity Center OpenID Connect uses the sso-oauth namespace.

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.

Field Summary

Fields

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

Method Summary

Modifier and Type	Method	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 access and refresh tokens for clients that are authenticated using client secrets.
default CreateTokenResponse	createToken(CreateTokenRequest createTokenRequest)	Creates and returns access and refresh tokens for clients that are authenticated using client secrets.
default CreateTokenWithIamResponse	createTokenWithIAM(Consumer<CreateTokenWithIamRequest.Builder> createTokenWithIamRequest)	Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user.
default CreateTokenWithIamResponse	createTokenWithIAM(CreateTokenWithIamRequest createTokenWithIamRequest)	Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user.
default RegisterClientResponse	registerClient(Consumer<RegisterClientRequest.Builder> registerClientRequest)	Registers a public client with IAM Identity Center.
default RegisterClientResponse	registerClient(RegisterClientRequest registerClientRequest)	Registers a public client with IAM Identity Center.
default SsoOidcServiceClientConfiguration	serviceClientConfiguration()	The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration
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.utils.SdkAutoCloseable

close

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

serviceName

Field Details

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 Details

createToken

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

Creates and returns access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication.

Parameters:

createTokenRequest -

Returns:

Result of the CreateToken operation returned by the service.

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 access and refresh tokens for clients that are authenticated using client secrets. The access token can be used to fetch short-lived credentials for the assigned AWS accounts or to access application APIs using bearer authentication.

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.

See Also:

• AWS API Documentation

createTokenWithIAM

default CreateTokenWithIamResponse createTokenWithIAM(CreateTokenWithIamRequest createTokenWithIamRequest)
                                               throws InvalidRequestException,
InvalidClientException,
InvalidGrantException,
UnauthorizedClientException,
UnsupportedGrantTypeException,
InvalidScopeException,
AuthorizationPendingException,
SlowDownException,
AccessDeniedException,
ExpiredTokenException,
InternalServerException,
InvalidRequestRegionException,
AwsServiceException,
SdkClientException,
SsoOidcException

Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user. These tokens might contain defined scopes that specify permissions such as read:profile or write:data. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer authentication.

This API is used with Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API Requests.

Parameters:

createTokenWithIamRequest -

Returns:

Result of the CreateTokenWithIAM operation returned by the service.

See Also:

• AWS API Documentation

createTokenWithIAM

default CreateTokenWithIamResponse createTokenWithIAM(Consumer<CreateTokenWithIamRequest.Builder> createTokenWithIamRequest)
                                               throws InvalidRequestException,
InvalidClientException,
InvalidGrantException,
UnauthorizedClientException,
UnsupportedGrantTypeException,
InvalidScopeException,
AuthorizationPendingException,
SlowDownException,
AccessDeniedException,
ExpiredTokenException,
InternalServerException,
InvalidRequestRegionException,
AwsServiceException,
SdkClientException,
SsoOidcException

Creates and returns access and refresh tokens for authorized client applications that are authenticated using any IAM entity, such as a service role or user. These tokens might contain defined scopes that specify permissions such as read:profile or write:data. Through downscoping, you can use the scopes parameter to request tokens with reduced permissions compared to the original client application's permissions or, if applicable, the refresh token's scopes. The access token can be used to fetch short-lived credentials for the assigned Amazon Web Services accounts or to access application APIs using bearer authentication.

This API is used with Signature Version 4. For more information, see Amazon Web Services Signature Version 4 for API Requests.

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

Parameters:

createTokenWithIamRequest - A Consumer that will call methods on CreateTokenWithIamRequest.Builder to create a request.

Returns:

Result of the CreateTokenWithIAM operation returned by the service.

See Also:

• AWS API Documentation

registerClient

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

Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.

Parameters:

registerClientRequest -

Returns:

Result of the RegisterClient operation returned by the service.

See Also:

• AWS API Documentation

registerClient

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

Registers a public client with IAM Identity Center. This allows clients to perform authorization using the authorization code grant with Proof Key for Code Exchange (PKCE) or the device code grant.

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.

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.

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.

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()

Description copied from interface: SdkClient

The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration

Specified by:

serviceClientConfiguration in interface AwsClient

Specified by:

serviceClientConfiguration in interface SdkClient

Returns:

SdkServiceClientConfiguration