@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class SamlProperties extends Object implements Serializable, Cloneable, StructuredPojo
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.
Constructor and Description |
---|
SamlProperties() |
Modifier and Type | Method and Description |
---|---|
SamlProperties |
clone() |
boolean |
equals(Object obj) |
String |
getRelayStateParameterName()
The relay state parameter name supported by the SAML 2.0 identity provider (IdP).
|
String |
getStatus()
Indicates the status of SAML 2.0 authentication.
|
String |
getUserAccessUrl()
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.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setRelayStateParameterName(String relayStateParameterName)
The relay state parameter name supported by the SAML 2.0 identity provider (IdP).
|
void |
setStatus(String status)
Indicates the status of SAML 2.0 authentication.
|
void |
setUserAccessUrl(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.
|
String |
toString()
Returns a string representation of this object.
|
SamlProperties |
withRelayStateParameterName(String relayStateParameterName)
The relay state parameter name supported by the SAML 2.0 identity provider (IdP).
|
SamlProperties |
withStatus(SamlStatusEnum status)
Indicates the status of SAML 2.0 authentication.
|
SamlProperties |
withStatus(String status)
Indicates the status of SAML 2.0 authentication.
|
SamlProperties |
withUserAccessUrl(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.
|
public void setStatus(String 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.
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.
SamlStatusEnum
public String getStatus()
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 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.
SamlStatusEnum
public SamlProperties withStatus(String 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.
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.
SamlStatusEnum
public SamlProperties withStatus(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.
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.
SamlStatusEnum
public void setUserAccessUrl(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.
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.public String getUserAccessUrl()
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.
public SamlProperties withUserAccessUrl(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.
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.public void setRelayStateParameterName(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.
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.
public String getRelayStateParameterName()
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.
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.
public SamlProperties withRelayStateParameterName(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.
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.
public String toString()
toString
in class Object
Object.toString()
public SamlProperties clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.