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.FinSpace.Types.FederationParameters

Description

Documentation

data FederationParameters Source #

Configuration information when authentication mode is FEDERATED.

See: newFederationParameters smart constructor.

Constructors

FederationParameters'

Fields

applicationCallBackURL :: Maybe Text
The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).
attributeMap :: Maybe (HashMap Text Text)
SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.
federationProviderName :: Maybe Text
Name of the identity provider (IdP).
federationURN :: Maybe Text
The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.
samlMetadataDocument :: Maybe Text
SAML 2.0 Metadata document from identity provider (IdP).
samlMetadataURL :: Maybe Text
Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

Instances

Instances details

FromJSON FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods parseJSON :: Value -> Parser FederationParameters # parseJSONList :: Value -> Parser [FederationParameters] #
ToJSON FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods toJSON :: FederationParameters -> Value # toEncoding :: FederationParameters -> Encoding # toJSONList :: [FederationParameters] -> Value # toEncodingList :: [FederationParameters] -> Encoding #
Generic FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Associated Types type Rep FederationParameters :: Type -> Type # Methods from :: FederationParameters -> Rep FederationParameters x # to :: Rep FederationParameters x -> FederationParameters #
Read FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods readsPrec :: Int -> ReadS FederationParameters # readList :: ReadS [FederationParameters] # readPrec :: ReadPrec FederationParameters # readListPrec :: ReadPrec [FederationParameters] #
Show FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods showsPrec :: Int -> FederationParameters -> ShowS # show :: FederationParameters -> String # showList :: [FederationParameters] -> ShowS #
NFData FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods rnf :: FederationParameters -> () #
Eq FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods (==) :: FederationParameters -> FederationParameters -> Bool # (/=) :: FederationParameters -> FederationParameters -> Bool #
Hashable FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters Methods hashWithSalt :: Int -> FederationParameters -> Int # hash :: FederationParameters -> Int #
type Rep FederationParameters Source #
Instance details Defined in Amazonka.FinSpace.Types.FederationParameters type Rep FederationParameters = D1 ('MetaData "FederationParameters" "Amazonka.FinSpace.Types.FederationParameters" "amazonka-finspace-2.0-D97KpJfy3e64ziV32Jkivv" 'False) (C1 ('MetaCons "FederationParameters'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationCallBackURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "attributeMap") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "federationProviderName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "federationURN") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "samlMetadataDocument") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "samlMetadataURL") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newFederationParameters :: FederationParameters Source #

Create a value of FederationParameters 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:applicationCallBackURL:FederationParameters', federationParameters_applicationCallBackURL - The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

$sel:attributeMap:FederationParameters', federationParameters_attributeMap - SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

$sel:federationProviderName:FederationParameters', federationParameters_federationProviderName - Name of the identity provider (IdP).

$sel:federationURN:FederationParameters', federationParameters_federationURN - The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

$sel:samlMetadataDocument:FederationParameters', federationParameters_samlMetadataDocument - SAML 2.0 Metadata document from identity provider (IdP).

$sel:samlMetadataURL:FederationParameters', federationParameters_samlMetadataURL - Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

federationParameters_applicationCallBackURL :: Lens' FederationParameters (Maybe Text) Source #

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

federationParameters_attributeMap :: Lens' FederationParameters (Maybe (HashMap Text Text)) Source #

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

federationParameters_federationProviderName :: Lens' FederationParameters (Maybe Text) Source #

Name of the identity provider (IdP).

federationParameters_federationURN :: Lens' FederationParameters (Maybe Text) Source #

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

federationParameters_samlMetadataDocument :: Lens' FederationParameters (Maybe Text) Source #

SAML 2.0 Metadata document from identity provider (IdP).

federationParameters_samlMetadataURL :: Lens' FederationParameters (Maybe Text) Source #

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).