java.lang.Object
- software.amazon.awssdk.services.workspaces.model.SamlProperties

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<SamlProperties.Builder,SamlProperties>
```
@Generated("software.amazon.awssdk:codegen")
public final class SamlProperties
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<SamlProperties.Builder,SamlProperties>
```
Describes the enablement status, user access URL, and relay state parameter name that are used for configuring federation with an SAML 2.0 identity provider.

See Also:

Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static interface SamlProperties.Builder

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`static SamlProperties.Builder`	`builder()`
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`relayStateParameterName()`	The relay state parameter name supported by the SAML 2.0 identity provider (IdP).
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends SamlProperties.Builder>`	`serializableBuilderClass()`
`SamlStatusEnum`	`status()`	Indicates the status of SAML 2.0 authentication.
`String`	`statusAsString()`	Indicates the status of SAML 2.0 authentication.
`SamlProperties.Builder`	`toBuilder()`
`String`	`toString()`	Returns a string representation of this object.
`String`	`userAccessUrl()`	The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.

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
  - status
```
public final SamlStatusEnum status()
```
    Indicates the status of SAML 2.0 authentication. These statuses include the following.
    
    If the setting is DISABLED, end users will be directed to login with their directory credentials.
    
    If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
    
    If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
    
    If the service returns an enum value that is not available in the current SDK version, status will return SamlStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    Indicates the status of SAML 2.0 authentication. These statuses include the following.
    
    If the setting is DISABLED, end users will be directed to login with their directory credentials.
    
    If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
    
    If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
    
    See Also:
    
    SamlStatusEnum
  - statusAsString
```
public final String statusAsString()
```
    Indicates the status of SAML 2.0 authentication. These statuses include the following.
    
    If the setting is DISABLED, end users will be directed to login with their directory credentials.
    
    If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
    
    If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
    
    If the service returns an enum value that is not available in the current SDK version, status will return SamlStatusEnum.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from statusAsString().
    Returns:
    
    Indicates the status of SAML 2.0 authentication. These statuses include the following.
    
    If the setting is DISABLED, end users will be directed to login with their directory credentials.
    
    If the setting is ENABLED, end users will be directed to login via the user access URL. Users attempting to connect to WorkSpaces from a client application that does not support SAML 2.0 authentication will not be able to connect.
    
    If the setting is ENABLED_WITH_DIRECTORY_LOGIN_FALLBACK, end users will be directed to login via the user access URL on supported client applications, but will not prevent clients that do not support SAML 2.0 authentication from connecting as if SAML 2.0 authentication was disabled.
    
    See Also:
    
    SamlStatusEnum
  - userAccessUrl
```
public final String userAccessUrl()
```
    The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
    
    Returns:
    
    The SAML 2.0 identity provider (IdP) user access URL is the URL a user would navigate to in their web browser in order to federate from the IdP and directly access the application, without any SAML 2.0 service provider (SP) bindings.
  - relayStateParameterName
```
public final String relayStateParameterName()
```
    The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
    
    To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
    
    Returns:
    
    The relay state parameter name supported by the SAML 2.0 identity provider (IdP). When the end user is redirected to the user access URL from the WorkSpaces client application, this relay state parameter name is appended as a query parameter to the URL along with the relay state endpoint to return the user to the client application session.
    
    To use SAML 2.0 authentication with WorkSpaces, the IdP must support IdP-initiated deep linking for the relay state URL. Consult your IdP documentation for more information.
  - toBuilder
```
public SamlProperties.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<SamlProperties.Builder,SamlProperties>
  - builder
```
public static SamlProperties.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends SamlProperties.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

Class SamlProperties

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

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

Method Detail

status

statusAsString

userAccessUrl

relayStateParameterName

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields