Package software.amazon.awssdk.services.ssoadmin.model

Class SignInOptions

java.lang.Object
software.amazon.awssdk.services.ssoadmin.model.SignInOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<SignInOptions.Builder,SignInOptions>
@Generated("software.amazon.awssdk:codegen") public final class SignInOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<SignInOptions.Builder,SignInOptions>

A structure that describes the sign-in options for an application portal.

See Also:

  • Method Details

    • applicationUrl

      public final String applicationUrl()

      The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.

      Returns:
      The URL that accepts authentication requests for an application. This is a required parameter if the Origin parameter is APPLICATION.

    • origin

      public final SignInOrigin origin()

      This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

      • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

      • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

      If the service returns an enum value that is not available in the current SDK version, origin will return SignInOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAsString().

      Returns:
      This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

      • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

      • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

      See Also:

    • originAsString

      public final String originAsString()

      This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

      • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

      • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

      If the service returns an enum value that is not available in the current SDK version, origin will return SignInOrigin.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from originAsString().

      Returns:
      This determines how IAM Identity Center navigates the user to the target application. It can be one of the following values:

      • APPLICATION: IAM Identity Center redirects the customer to the configured ApplicationUrl.

      • IDENTITY_CENTER: IAM Identity Center uses SAML identity-provider initiated authentication to sign the customer directly into a SAML-based application.

      See Also:

    • toBuilder

      public SignInOptions.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<SignInOptions.Builder,SignInOptions>
      Returns:
      a builder for type T

    • builder

      public static SignInOptions.Builder builder()

    • serializableBuilderClass

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

    • hashCode

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

    • equals

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

    • 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)

    • 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.