com.amazonaws.services.ssooidc

Class AWSSSOOIDCClient

java.lang.Object

com.amazonaws.AmazonWebServiceClient

com.amazonaws.services.ssooidc.AWSSSOOIDCClient

All Implemented Interfaces:

AWSSSOOIDC

Direct Known Subclasses:

AWSSSOOIDCAsyncClient

@ThreadSafe
 @Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AWSSSOOIDCClient
extends AmazonWebServiceClient
implements AWSSSOOIDC

Client for accessing SSO OIDC. All service calls made using this client are blocking, and will not return until the service call completes.

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 inherited from class com.amazonaws.AmazonWebServiceClient

LOGGING_AWS_REQUEST_METRIC

Fields inherited from interface com.amazonaws.services.ssooidc.AWSSSOOIDC

ENDPOINT_PREFIX

Method Summary

Modifier and Type	Method and Description
static AWSSSOOIDCClientBuilder	builder()
CreateTokenResult	createToken(CreateTokenRequest request) Creates and returns an access token for the authorized client.
ResponseMetadata	getCachedResponseMetadata(AmazonWebServiceRequest request) Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected.
RegisterClientResult	registerClient(RegisterClientRequest request) Registers a client with IAM Identity Center.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.
StartDeviceAuthorizationResult	startDeviceAuthorization(StartDeviceAuthorizationRequest request) Initiates device authorization by requesting a pair of verification codes from the authorization service.

Methods inherited from class com.amazonaws.AmazonWebServiceClient

addRequestHandler, addRequestHandler, configureRegion, getClientConfiguration, getEndpointPrefix, getMonitoringListeners, getRequestMetricsCollector, getServiceName, getSignerByURI, getSignerOverride, getSignerRegionOverride, getTimeOffset, makeImmutable, removeRequestHandler, removeRequestHandler, setEndpoint, setEndpoint, setRegion, setServiceNameIntern, setSignerRegionOverride, setTimeOffset, withEndpoint, withRegion, withRegion, withTimeOffset

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static AWSSSOOIDCClientBuilder builder()

createToken

public CreateTokenResult createToken(CreateTokenRequest request)

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.

Specified by:

createToken in interface AWSSSOOIDC

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.

See Also:

AWS API Documentation

registerClient

public RegisterClientResult registerClient(RegisterClientRequest request)

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.

Specified by:

registerClient in interface AWSSSOOIDC

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.

See Also:

AWS API Documentation

startDeviceAuthorization

public StartDeviceAuthorizationResult startDeviceAuthorization(StartDeviceAuthorizationRequest request)

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

Specified by:

startDeviceAuthorization in interface AWSSSOOIDC

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.

See Also:

AWS API Documentation

getCachedResponseMetadata

public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)

Returns additional metadata for a previously executed successful, request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.

Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing the request.

Specified by:

getCachedResponseMetadata in interface AWSSSOOIDC

Parameters:

request - The originally executed request

Returns:

The response metadata for the specified request, or null if none is available.

shutdown

public void shutdown()

Description copied from class: AmazonWebServiceClient

Shuts down this client object, releasing any resources that might be held open. If this method is not invoked, resources may be leaked. Once a client has been shutdown, it should not be used to make any more requests.

Specified by:

shutdown in interface AWSSSOOIDC

Overrides:

shutdown in class AmazonWebServiceClient