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

Class CreateTokenWithIamResponse

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

  • Method Details

    • accessToken

      public final String accessToken()

      A bearer token to access Amazon Web Services accounts and applications assigned to a user.

      Returns:
      A bearer token to access Amazon Web Services accounts and applications assigned to a user.

    • tokenType

      public final String tokenType()

      Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

      Returns:
      Used to notify the requester that the returned token is an access token. The supported token type is Bearer.

    • expiresIn

      public final Integer expiresIn()

      Indicates the time in seconds when an access token will expire.

      Returns:
      Indicates the time in seconds when an access token will expire.

    • refreshToken

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

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

      public final String idToken()

      A JSON Web Token (JWT) that identifies the user associated with the issued access token.

      Returns:
      A JSON Web Token (JWT) that identifies the user associated with the issued access token.

    • issuedTokenType

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

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

    • 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 granted. The access token that is issued is limited to the scopes that are granted.

      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 granted. The access token that is issued is limited to the scopes that are granted.

    • toBuilder

      public CreateTokenWithIamResponse.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<CreateTokenWithIamResponse.Builder,CreateTokenWithIamResponse>
      Specified by:
      toBuilder in class AwsResponse
      Returns:
      a builder for type T

    • builder

      public static CreateTokenWithIamResponse.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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: SdkResponse
      Used to retrieve the value of a field from any class that extends SdkResponse. 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 SdkResponse.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkResponse
      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.