Package software.amazon.awssdk.services.ssooidc.model

Class CreateTokenWithIamRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.ssooidc.model.SsoOidcRequest
software.amazon.awssdk.services.ssooidc.model.CreateTokenWithIamRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateTokenWithIamRequest.Builder,CreateTokenWithIamRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateTokenWithIamRequest extends SsoOidcRequest implements ToCopyableBuilder<CreateTokenWithIamRequest.Builder,CreateTokenWithIamRequest>

  • Method Details

    • clientId

      public final String clientId()

      The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

      Returns:
      The unique identifier string for the client or application. This value is an application ARN that has OAuth grants configured.

    • grantType

      public final 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

      Returns:
      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

      public final 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.

      Returns:
      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

      public final 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.

      Returns:
      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

      public final 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.

      Returns:
      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.

    • hasScope

      public final boolean hasScope()
      For responses, this returns true if the service returned a value for the Scope property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • scope

      public final List<String> 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.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasScope() method.

      Returns:
      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

      public final 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.

      Returns:
      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

      public final 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.

      Returns:
      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

      public final 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

      Returns:
      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

      public final 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

      Returns:
      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

    • toBuilder

      public CreateTokenWithIamRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateTokenWithIamRequest.Builder,CreateTokenWithIamRequest>
      Specified by:
      toBuilder in class SsoOidcRequest
      Returns:
      a builder for type T

    • builder

      public static CreateTokenWithIamRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateTokenWithIamRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.