Interface SsoOidcClient
- All Superinterfaces:
AutoCloseable
,AwsClient
,SdkAutoCloseable
,SdkClient
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.
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.
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
Value for looking up the service's metadata from theServiceMetadataProvider
.static final String
-
Method Summary
Modifier and TypeMethodDescriptionstatic SsoOidcClientBuilder
builder()
Create a builder that can be used to configure and create aSsoOidcClient
.static SsoOidcClient
create()
Create aSsoOidcClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
.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 clients and applications that are authenticated using IAM entities.default CreateTokenWithIamResponse
createTokenWithIAM
(CreateTokenWithIamRequest createTokenWithIamRequest) Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM entities.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.The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfigurationstatic 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
- See Also:
-
SERVICE_METADATA_ID
Value for looking up the service's metadata from theServiceMetadataProvider
.- See Also:
-
-
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-term 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:
-
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-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
CreateTokenRequest.Builder
avoiding the need to create one manually viaCreateTokenRequest.builder()
- Parameters:
createTokenRequest
- AConsumer
that will call methods onCreateTokenRequest.Builder
to create a request.- Returns:
- Result of the CreateToken operation returned by the service.
- See Also:
-
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 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.- Parameters:
createTokenWithIamRequest
-- Returns:
- Result of the CreateTokenWithIAM operation returned by the service.
- See Also:
-
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 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
CreateTokenWithIamRequest.Builder
avoiding the need to create one manually viaCreateTokenWithIamRequest.builder()
- Parameters:
createTokenWithIamRequest
- AConsumer
that will call methods onCreateTokenWithIamRequest.Builder
to create a request.- Returns:
- Result of the CreateTokenWithIAM operation returned by the service.
- See Also:
-
registerClient
default RegisterClientResponse registerClient(RegisterClientRequest registerClientRequest) throws InvalidRequestException, InvalidScopeException, InvalidClientMetadataException, InternalServerException, InvalidRedirectUriException, UnsupportedGrantTypeException, 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.
- See Also:
-
registerClient
default RegisterClientResponse registerClient(Consumer<RegisterClientRequest.Builder> registerClientRequest) throws InvalidRequestException, InvalidScopeException, InvalidClientMetadataException, InternalServerException, InvalidRedirectUriException, UnsupportedGrantTypeException, 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 viaRegisterClientRequest.builder()
- Parameters:
registerClientRequest
- AConsumer
that will call methods onRegisterClientRequest.Builder
to create a request.- Returns:
- Result of the RegisterClient operation returned by the service.
- See Also:
-
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:
-
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 viaStartDeviceAuthorizationRequest.builder()
- Parameters:
startDeviceAuthorizationRequest
- AConsumer
that will call methods onStartDeviceAuthorizationRequest.Builder
to create a request.- Returns:
- Result of the StartDeviceAuthorization operation returned by the service.
- See Also:
-
create
Create aSsoOidcClient
with the region loaded from theDefaultAwsRegionProviderChain
and credentials loaded from theDefaultCredentialsProvider
. -
builder
Create a builder that can be used to configure and create aSsoOidcClient
. -
serviceMetadata
-
serviceClientConfiguration
Description copied from interface:SdkClient
The SDK service client configuration exposes client settings to the user, e.g., ClientOverrideConfiguration- Specified by:
serviceClientConfiguration
in interfaceAwsClient
- Specified by:
serviceClientConfiguration
in interfaceSdkClient
- Returns:
- SdkServiceClientConfiguration
-