@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AWSSSOOIDC
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAWSSSOOIDC instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CreateTokenResult |
createToken (CreateTokenRequest createTokenRequest)
Creates and returns access and refresh tokens for clients that are authenticated using client secrets.
|
CreateTokenWithIAMResult |
createTokenWithIAM (CreateTokenWithIAMRequest createTokenWithIAMRequest)
Creates and returns access and refresh tokens for clients and applications that are authenticated using IAM
entities.
|
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 registerClientRequest)
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 startDeviceAuthorizationRequest)
Initiates device authorization by requesting a pair of verification codes from the authorization service.
|
static final String ENDPOINT_PREFIX
CreateTokenResult createToken(CreateTokenRequest createTokenRequest)
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.
createTokenRequest - 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.CreateTokenWithIAMResult createTokenWithIAM(CreateTokenWithIAMRequest createTokenWithIAMRequest)
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.
createTokenWithIAMRequest - 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.InvalidRequestRegionException - Indicates that a token provided as input to the request was issued by and is only usable by calling IAM
Identity Center endpoints in another region.RegisterClientResult registerClient(RegisterClientRequest registerClientRequest)
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.
registerClientRequest - 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.InvalidRedirectUriException - Indicates that one or more redirect URI in the request is not supported for this operation.UnsupportedGrantTypeException - Indicates that the grant type in the request is not supported by the service.StartDeviceAuthorizationResult startDeviceAuthorization(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest)
Initiates device authorization by requesting a pair of verification codes from the authorization service.
startDeviceAuthorizationRequest - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
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 a request.
request - The originally executed request.