Struct aws_sdk_workspaces::types::SamlProperties

#[non_exhaustive]
pub struct SamlProperties { /* private fields */ }

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.

Implementations

impl SamlProperties

pub fn status(&self) -> Option<&SamlStatusEnum>

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.

pub fn user_access_url(&self) -> Option<&str>

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.

pub fn relay_state_parameter_name(&self) -> Option<&str>

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.

impl SamlProperties

pub fn builder() -> SamlPropertiesBuilder

Creates a new builder-style object to manufacture SamlProperties.

Trait Implementations

impl Clone for SamlProperties

fn clone(&self) -> SamlProperties

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for SamlProperties

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq<SamlProperties> for SamlProperties

fn eq(&self, other: &SamlProperties) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for SamlProperties