Serialized Form (AWS Java SDK for AWS SSO OIDC 1.12.730 API)

Package com.amazonaws.services.ssooidc.model
- Class com.amazonaws.services.ssooidc.model.AccessDeniedException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be access_denied.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.AuthorizationPendingException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be authorization_pending.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.AWSSSOOIDCException extends AmazonServiceException implements Serializable
  
  serialVersionUID:
  
  1L
- Class com.amazonaws.services.ssooidc.model.CreateTokenRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The unique identifier string for the client or application. This value comes from the result of the RegisterClient API.
    - clientSecret
```
String clientSecret
```
      A secret string generated for the client. This value should come from the persisted result of the RegisterClient API.
    - grantType
```
String grantType
```
      Supports the following OAuth grant types: Device Code and Refresh Token. Specify either of the following values, depending on the grant type that you want:
      
      * Device Code - urn:ietf:params:oauth:grant-type:device_code
      
      * Refresh Token - refresh_token
      
      For information about how to obtain the device code, see the StartDeviceAuthorization topic.
    - deviceCode
```
String deviceCode
```
      Used only when calling this API for the Device Code grant type. This short-term code is used to identify this authorization request. This comes from the result of the StartDeviceAuthorization API.
    - code
```
String code
```
      Used only when calling this API for the Authorization Code grant type. The short-term code is used to identify this authorization request. This grant type is currently unsupported for the CreateToken API.
    - refreshToken
```
String refreshToken
```
      Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
      
      For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
    - scope
```
List<E> scope
```
      The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If this value is not specified, IAM Identity Center authorizes all scopes that are configured for the client during the call to RegisterClient.
    - redirectUri
```
String redirectUri
```
      Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
    - codeVerifier
```
String codeVerifier
```
      Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
- Class com.amazonaws.services.ssooidc.model.CreateTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A bearer token to access Amazon Web Services accounts and applications assigned to a user.
    - tokenType
```
String tokenType
```
      Used to notify the client that the returned token is an access token. The supported token type is Bearer.
    - expiresIn
```
Integer expiresIn
```
      Indicates the time in seconds when an access token will expire.
    - refreshToken
```
String refreshToken
```
      A token that, if present, can be used to refresh a previously issued access token that might have expired.
      
      For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
    - idToken
```
String idToken
```
      The idToken is not implemented or supported. For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
      
      A JSON Web Token (JWT) that identifies who is associated with the issued access token.
- Class com.amazonaws.services.ssooidc.model.CreateTokenWithIAMRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.
    - grantType
```
String grantType
```
      Supports the following OAuth grant types: Authorization Code, Refresh Token, JWT Bearer, and Token Exchange. Specify one of the following values, depending on the grant type that you want:
      
      * Authorization Code - authorization_code
      
      * Refresh Token - refresh_token
      
      * JWT Bearer - urn:ietf:params:oauth:grant-type:jwt-bearer
      
      * Token Exchange - urn:ietf:params:oauth:grant-type:token-exchange
    - code
```
String code
```
      Used only when calling this API for the Authorization Code grant type. This short-term code is used to identify this authorization request. The code is obtained through a redirect from IAM Identity Center to a redirect URI persisted in the Authorization Code GrantOptions for the application.
    - refreshToken
```
String refreshToken
```
      Used only when calling this API for the Refresh Token grant type. This token is used to refresh short-term tokens, such as the access token, that might expire.
      
      For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
    - assertion
```
String assertion
```
      Used only when calling this API for the JWT Bearer grant type. This value specifies the JSON Web Token (JWT) issued by a trusted token issuer. To authorize a trusted token issuer, configure the JWT Bearer GrantOptions for the application.
    - scope
```
List<E> scope
```
      The list of scopes for which authorization is requested. The access token that is issued is limited to the scopes that are granted. If the value is not specified, IAM Identity Center authorizes all scopes configured for the application, including the following default scopes: openid, aws, sts:identity_context.
    - redirectUri
```
String redirectUri
```
      Used only when calling this API for the Authorization Code grant type. This value specifies the location of the client or application that has registered to receive the authorization code.
    - subjectToken
```
String subjectToken
```
      Used only when calling this API for the Token Exchange grant type. This value specifies the subject of the exchange. The value of the subject token must be an access token issued by IAM Identity Center to a different client or application. The access token must have authorized scopes that indicate the requested application as a target audience.
    - subjectTokenType
```
String subjectTokenType
```
      Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that is passed as the subject of the exchange. The following value is supported:
      
      * Access Token - urn:ietf:params:oauth:token-type:access_token
    - requestedTokenType
```
String requestedTokenType
```
      Used only when calling this API for the Token Exchange grant type. This value specifies the type of token that the requester can receive. The following values are supported:
      
      * Access Token - urn:ietf:params:oauth:token-type:access_token
      
      * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
    - codeVerifier
```
String codeVerifier
```
      Used only when calling this API for the Authorization Code grant type. This value is generated by the client and presented to validate the original code challenge value the client passed at authorization time.
- Class com.amazonaws.services.ssooidc.model.CreateTokenWithIAMResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - accessToken
```
String accessToken
```
      A bearer token to access Amazon Web Services accounts and applications assigned to a user.
    - tokenType
```
String tokenType
```
      Used to notify the requester that the returned token is an access token. The supported token type is Bearer.
    - expiresIn
```
Integer expiresIn
```
      Indicates the time in seconds when an access token will expire.
    - refreshToken
```
String refreshToken
```
      A token that, if present, can be used to refresh a previously issued access token that might have expired.
      
      For more information about the features and limitations of the current IAM Identity Center OIDC implementation, see Considerations for Using this Guide in the IAM Identity Center OIDC API Reference.
    - idToken
```
String idToken
```
      A JSON Web Token (JWT) that identifies the user associated with the issued access token.
    - issuedTokenType
```
String issuedTokenType
```
      Indicates the type of tokens that are issued by IAM Identity Center. The following values are supported:
      
      * Access Token - urn:ietf:params:oauth:token-type:access_token
      
      * Refresh Token - urn:ietf:params:oauth:token-type:refresh_token
    - scope
```
List<E> scope
```
      The list of scopes for which authorization is granted. The access token that is issued is limited to the scopes that are granted.
- Class com.amazonaws.services.ssooidc.model.ExpiredTokenException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be expired_token.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InternalServerException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be server_error.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InvalidClientException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_client.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InvalidClientMetadataException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_client_metadata.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InvalidGrantException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_grant.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InvalidRedirectUriException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_redirect_uri.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InvalidRequestException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_request.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.InvalidRequestRegionException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_request.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
    - endpoint
```
String endpoint
```
      Indicates the IAM Identity Center endpoint which the requester may call with this token.
    - region
```
String region
```
      Indicates the region which the requester may call with this token.
- Class com.amazonaws.services.ssooidc.model.InvalidScopeException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be invalid_scope.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.RegisterClientRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientName
```
String clientName
```
      The friendly name of the client.
    - clientType
```
String clientType
```
      The type of client. The service supports only public as a client type. Anything other than public will be rejected by the service.
    - scopes
```
List<E> scopes
```
      The list of scopes that are defined by the client. Upon authorization, this list is used to restrict permissions when granting an access token.
    - redirectUris
```
List<E> redirectUris
```
      The list of redirect URI that are defined by the client. At completion of authorization, this list is used to restrict what locations the user agent can be redirected back to.
    - grantTypes
```
List<E> grantTypes
```
      The list of OAuth 2.0 grant types that are defined by the client. This list is used to restrict the token granting flows available to the client.
    - issuerUrl
```
String issuerUrl
```
      The IAM Identity Center Issuer URL associated with an instance of IAM Identity Center. This value is needed for user access to resources through the client.
    - entitledApplicationArn
```
String entitledApplicationArn
```
      This IAM Identity Center application ARN is used to define administrator-managed configuration for public client access to resources. At authorization, the scopes, grants, and redirect URI available to this client will be restricted by this application resource.
- Class com.amazonaws.services.ssooidc.model.RegisterClientResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The unique identifier string for each client. This client uses this identifier to get authenticated by the service in subsequent calls.
    - clientSecret
```
String clientSecret
```
      A secret string generated for the client. The client will use this string to get authenticated by the service in subsequent calls.
    - clientIdIssuedAt
```
Long clientIdIssuedAt
```
      Indicates the time at which the clientId and clientSecret were issued.
    - clientSecretExpiresAt
```
Long clientSecretExpiresAt
```
      Indicates the time at which the clientId and clientSecret will become invalid.
    - authorizationEndpoint
```
String authorizationEndpoint
```
      An endpoint that the client can use to request authorization.
    - tokenEndpoint
```
String tokenEndpoint
```
      An endpoint that the client can use to create tokens.
- Class com.amazonaws.services.ssooidc.model.SlowDownException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be slow_down.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.StartDeviceAuthorizationRequest extends AmazonWebServiceRequest implements Serializable
  - Serialized Fields
    - clientId
```
String clientId
```
      The unique identifier string for the client that is registered with IAM Identity Center. This value should come from the persisted result of the RegisterClient API operation.
    - clientSecret
```
String clientSecret
```
      A secret string that is generated for the client. This value should come from the persisted result of the RegisterClient API operation.
    - startUrl
```
String startUrl
```
      The URL for the Amazon Web Services access portal. For more information, see Using the Amazon Web Services access portal in the IAM Identity Center User Guide.
- Class com.amazonaws.services.ssooidc.model.StartDeviceAuthorizationResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable
  - Serialized Fields
    - deviceCode
```
String deviceCode
```
      The short-lived code that is used by the device when polling for a session token.
    - userCode
```
String userCode
```
      A one-time user verification code. This is needed to authorize an in-use device.
    - verificationUri
```
String verificationUri
```
      The URI of the verification page that takes the userCode to authorize the device.
    - verificationUriComplete
```
String verificationUriComplete
```
      An alternate URL that the client can use to automatically launch a browser. This process skips the manual step in which the user visits the verification page and enters their code.
    - expiresIn
```
Integer expiresIn
```
      Indicates the number of seconds in which the verification code will become invalid.
    - interval
```
Integer interval
```
      Indicates the number of seconds the client must wait between attempts when polling for a session.
- Class com.amazonaws.services.ssooidc.model.UnauthorizedClientException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be unauthorized_client.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.
- Class com.amazonaws.services.ssooidc.model.UnsupportedGrantTypeException extends AWSSSOOIDCException implements Serializable
  
  serialVersionUID:
  
  1L
  - Serialized Fields
    - error
```
String error
```
      Single error code. For this exception the value will be unsupported_grant_type.
    - error_description
```
String error_description
```
      Human-readable text providing additional information, used to assist the client developer in understanding the error that occurred.

Serialized Form

Package com.amazonaws.services.ssooidc.model

Class com.amazonaws.services.ssooidc.model.AccessDeniedException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.AuthorizationPendingException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.AWSSSOOIDCException extends AmazonServiceException implements Serializable

Class com.amazonaws.services.ssooidc.model.CreateTokenRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

clientSecret

grantType

deviceCode

code

refreshToken

scope

redirectUri

codeVerifier

Class com.amazonaws.services.ssooidc.model.CreateTokenResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

accessToken

tokenType

expiresIn

refreshToken

idToken

Class com.amazonaws.services.ssooidc.model.CreateTokenWithIAMRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

clientId

grantType

code

refreshToken

assertion

scope

redirectUri

subjectToken

subjectTokenType

requestedTokenType

codeVerifier

Class com.amazonaws.services.ssooidc.model.CreateTokenWithIAMResult extends AmazonWebServiceResult<ResponseMetadata> implements Serializable

Serialized Fields

accessToken

tokenType

expiresIn

refreshToken

idToken

issuedTokenType

scope

Class com.amazonaws.services.ssooidc.model.ExpiredTokenException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InternalServerException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InvalidClientException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InvalidClientMetadataException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InvalidGrantException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InvalidRedirectUriException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InvalidRequestException extends AWSSSOOIDCException implements Serializable

Serialized Fields

error

error_description

Class com.amazonaws.services.ssooidc.model.InvalidRequestRegionException extends AWSSSOOIDCException implements Serializable