com.amazonaws.services.ssooidc

Interface AWSSSOOIDC

All Known Subinterfaces:

AWSSSOOIDCAsync

All Known Implementing Classes:

AbstractAWSSSOOIDC, AbstractAWSSSOOIDCAsync, AWSSSOOIDCAsyncClient, AWSSSOOIDCClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AWSSSOOIDC

Interface for accessing SSO OIDC.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAWSSSOOIDC instead.

AWS Single Sign-On (SSO) OpenID Connect (OIDC) is a web service that enables a client (such as AWS CLI or a native application) to register with AWS SSO. The service also enables the client to fetch the user’s access token upon successful authentication and authorization with AWS SSO. This service conforms with the OAuth 2.0 based implementation of the device authorization grant standard (https://tools.ietf.org/html/rfc8628).

For general information about AWS SSO, see What is AWS Single Sign-On? in the AWS SSO User Guide.

This API reference guide describes the AWS SSO OIDC operations that you can call programatically and includes detailed information on data types and errors.

AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms such as Java, Ruby, .Net, iOS, and Android. The SDKs provide a convenient way to create programmatic access to AWS SSO and other AWS services. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateTokenResult	createToken(CreateTokenRequest createTokenRequest) 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 registerClientRequest) Registers a client with AWS SSO.
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.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createToken

CreateTokenResult createToken(CreateTokenRequest createTokenRequest)

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.

See Also:

AWS API Documentation

registerClient

RegisterClientResult registerClient(RegisterClientRequest registerClientRequest)

Registers a client with AWS SSO. 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.

See Also:

AWS API Documentation

startDeviceAuthorization

StartDeviceAuthorizationResult startDeviceAuthorization(StartDeviceAuthorizationRequest startDeviceAuthorizationRequest)

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.

getCachedResponseMetadata

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 a request.

Parameters:

request - The originally executed request.

Returns:

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