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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SignInOptions.Builder

Method Summary

Modifier and Type	Method	Description
String	applicationUrl()	The URL that accepts authentication requests for an application.
static SignInOptions.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
SignInOrigin	origin()	This determines how IAM Identity Center navigates the user to the target application.
String	originAsString()	This determines how IAM Identity Center navigates the user to the target application.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends SignInOptions.Builder>	serializableBuilderClass()
SignInOptions.Builder	toBuilder()
String	toString()	Returns a string representation of this object.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

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:

SignInOrigin

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:

SignInOrigin

toBuilder

public SignInOptions.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SignInOptions.Builder,SignInOptions>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo