Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkSpaces.Types.SamlProperties

Description

Documentation

data SamlProperties Source #

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: newSamlProperties smart constructor.

Constructors

SamlProperties'

Fields

relayStateParameterName :: Maybe Text
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.
status :: Maybe 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.
userAccessUrl :: Maybe Text
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.

Instances

Instances details

FromJSON SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods parseJSON :: Value -> Parser SamlProperties # parseJSONList :: Value -> Parser [SamlProperties] #
ToJSON SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods toJSON :: SamlProperties -> Value # toEncoding :: SamlProperties -> Encoding # toJSONList :: [SamlProperties] -> Value # toEncodingList :: [SamlProperties] -> Encoding #
Generic SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Associated Types type Rep SamlProperties :: Type -> Type # Methods from :: SamlProperties -> Rep SamlProperties x # to :: Rep SamlProperties x -> SamlProperties #
Read SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods readsPrec :: Int -> ReadS SamlProperties # readList :: ReadS [SamlProperties] # readPrec :: ReadPrec SamlProperties # readListPrec :: ReadPrec [SamlProperties] #
Show SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods showsPrec :: Int -> SamlProperties -> ShowS # show :: SamlProperties -> String # showList :: [SamlProperties] -> ShowS #
NFData SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods rnf :: SamlProperties -> () #
Eq SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods (==) :: SamlProperties -> SamlProperties -> Bool # (/=) :: SamlProperties -> SamlProperties -> Bool #
Hashable SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties Methods hashWithSalt :: Int -> SamlProperties -> Int # hash :: SamlProperties -> Int #
type Rep SamlProperties Source #
Instance details Defined in Amazonka.WorkSpaces.Types.SamlProperties type Rep SamlProperties = D1 ('MetaData "SamlProperties" "Amazonka.WorkSpaces.Types.SamlProperties" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "SamlProperties'" 'PrefixI 'True) (S1 ('MetaSel ('Just "relayStateParameterName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe SamlStatusEnum)) :: S1 ('MetaSel ('Just "userAccessUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newSamlProperties :: SamlProperties Source #

Create a value of SamlProperties with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:relayStateParameterName:SamlProperties', samlProperties_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.

$sel:status:SamlProperties', samlProperties_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.

$sel:userAccessUrl:SamlProperties', samlProperties_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.

samlProperties_relayStateParameterName :: Lens' SamlProperties (Maybe Text) Source #

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.

samlProperties_status :: Lens' SamlProperties (Maybe SamlStatusEnum) Source #

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.

samlProperties_userAccessUrl :: Lens' SamlProperties (Maybe Text) Source #

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.