{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.FinSpace.Types.FederationParameters
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
module Amazonka.FinSpace.Types.FederationParameters where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import qualified Amazonka.Prelude as Prelude

-- | Configuration information when authentication mode is FEDERATED.
--
-- /See:/ 'newFederationParameters' smart constructor.
data FederationParameters = FederationParameters'
  { -- | The redirect or sign-in URL that should be entered into the SAML 2.0
    -- compliant identity provider configuration (IdP).
    FederationParameters -> Maybe Text
applicationCallBackURL :: Prelude.Maybe Prelude.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.
    FederationParameters -> Maybe (HashMap Text Text)
attributeMap :: Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text),
    -- | Name of the identity provider (IdP).
    FederationParameters -> Maybe Text
federationProviderName :: Prelude.Maybe Prelude.Text,
    -- | The Uniform Resource Name (URN). Also referred as Service Provider URN
    -- or Audience URI or Service Provider Entity ID.
    FederationParameters -> Maybe Text
federationURN :: Prelude.Maybe Prelude.Text,
    -- | SAML 2.0 Metadata document from identity provider (IdP).
    FederationParameters -> Maybe Text
samlMetadataDocument :: Prelude.Maybe Prelude.Text,
    -- | Provide the metadata URL from your SAML 2.0 compliant identity provider
    -- (IdP).
    FederationParameters -> Maybe Text
samlMetadataURL :: Prelude.Maybe Prelude.Text
  }
  deriving (FederationParameters -> FederationParameters -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: FederationParameters -> FederationParameters -> Bool
$c/= :: FederationParameters -> FederationParameters -> Bool
== :: FederationParameters -> FederationParameters -> Bool
$c== :: FederationParameters -> FederationParameters -> Bool
Prelude.Eq, ReadPrec [FederationParameters]
ReadPrec FederationParameters
Int -> ReadS FederationParameters
ReadS [FederationParameters]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [FederationParameters]
$creadListPrec :: ReadPrec [FederationParameters]
readPrec :: ReadPrec FederationParameters
$creadPrec :: ReadPrec FederationParameters
readList :: ReadS [FederationParameters]
$creadList :: ReadS [FederationParameters]
readsPrec :: Int -> ReadS FederationParameters
$creadsPrec :: Int -> ReadS FederationParameters
Prelude.Read, Int -> FederationParameters -> ShowS
[FederationParameters] -> ShowS
FederationParameters -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [FederationParameters] -> ShowS
$cshowList :: [FederationParameters] -> ShowS
show :: FederationParameters -> String
$cshow :: FederationParameters -> String
showsPrec :: Int -> FederationParameters -> ShowS
$cshowsPrec :: Int -> FederationParameters -> ShowS
Prelude.Show, forall x. Rep FederationParameters x -> FederationParameters
forall x. FederationParameters -> Rep FederationParameters x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep FederationParameters x -> FederationParameters
$cfrom :: forall x. FederationParameters -> Rep FederationParameters x
Prelude.Generic)

-- |
-- Create a value of 'FederationParameters' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'applicationCallBackURL', 'federationParameters_applicationCallBackURL' - The redirect or sign-in URL that should be entered into the SAML 2.0
-- compliant identity provider configuration (IdP).
--
-- 'attributeMap', '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.
--
-- 'federationProviderName', 'federationParameters_federationProviderName' - Name of the identity provider (IdP).
--
-- 'federationURN', 'federationParameters_federationURN' - The Uniform Resource Name (URN). Also referred as Service Provider URN
-- or Audience URI or Service Provider Entity ID.
--
-- 'samlMetadataDocument', 'federationParameters_samlMetadataDocument' - SAML 2.0 Metadata document from identity provider (IdP).
--
-- 'samlMetadataURL', 'federationParameters_samlMetadataURL' - Provide the metadata URL from your SAML 2.0 compliant identity provider
-- (IdP).
newFederationParameters ::
  FederationParameters
newFederationParameters :: FederationParameters
newFederationParameters =
  FederationParameters'
    { $sel:applicationCallBackURL:FederationParameters' :: Maybe Text
applicationCallBackURL =
        forall a. Maybe a
Prelude.Nothing,
      $sel:attributeMap:FederationParameters' :: Maybe (HashMap Text Text)
attributeMap = forall a. Maybe a
Prelude.Nothing,
      $sel:federationProviderName:FederationParameters' :: Maybe Text
federationProviderName = forall a. Maybe a
Prelude.Nothing,
      $sel:federationURN:FederationParameters' :: Maybe Text
federationURN = forall a. Maybe a
Prelude.Nothing,
      $sel:samlMetadataDocument:FederationParameters' :: Maybe Text
samlMetadataDocument = forall a. Maybe a
Prelude.Nothing,
      $sel:samlMetadataURL:FederationParameters' :: Maybe Text
samlMetadataURL = forall a. Maybe a
Prelude.Nothing
    }

-- | The redirect or sign-in URL that should be entered into the SAML 2.0
-- compliant identity provider configuration (IdP).
federationParameters_applicationCallBackURL :: Lens.Lens' FederationParameters (Prelude.Maybe Prelude.Text)
federationParameters_applicationCallBackURL :: Lens' FederationParameters (Maybe Text)
federationParameters_applicationCallBackURL = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FederationParameters' {Maybe Text
applicationCallBackURL :: Maybe Text
$sel:applicationCallBackURL:FederationParameters' :: FederationParameters -> Maybe Text
applicationCallBackURL} -> Maybe Text
applicationCallBackURL) (\s :: FederationParameters
s@FederationParameters' {} Maybe Text
a -> FederationParameters
s {$sel:applicationCallBackURL:FederationParameters' :: Maybe Text
applicationCallBackURL = Maybe Text
a} :: FederationParameters)

-- | 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_attributeMap :: Lens.Lens' FederationParameters (Prelude.Maybe (Prelude.HashMap Prelude.Text Prelude.Text))
federationParameters_attributeMap :: Lens' FederationParameters (Maybe (HashMap Text Text))
federationParameters_attributeMap = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FederationParameters' {Maybe (HashMap Text Text)
attributeMap :: Maybe (HashMap Text Text)
$sel:attributeMap:FederationParameters' :: FederationParameters -> Maybe (HashMap Text Text)
attributeMap} -> Maybe (HashMap Text Text)
attributeMap) (\s :: FederationParameters
s@FederationParameters' {} Maybe (HashMap Text Text)
a -> FederationParameters
s {$sel:attributeMap:FederationParameters' :: Maybe (HashMap Text Text)
attributeMap = Maybe (HashMap Text Text)
a} :: FederationParameters) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | Name of the identity provider (IdP).
federationParameters_federationProviderName :: Lens.Lens' FederationParameters (Prelude.Maybe Prelude.Text)
federationParameters_federationProviderName :: Lens' FederationParameters (Maybe Text)
federationParameters_federationProviderName = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FederationParameters' {Maybe Text
federationProviderName :: Maybe Text
$sel:federationProviderName:FederationParameters' :: FederationParameters -> Maybe Text
federationProviderName} -> Maybe Text
federationProviderName) (\s :: FederationParameters
s@FederationParameters' {} Maybe Text
a -> FederationParameters
s {$sel:federationProviderName:FederationParameters' :: Maybe Text
federationProviderName = Maybe Text
a} :: FederationParameters)

-- | The Uniform Resource Name (URN). Also referred as Service Provider URN
-- or Audience URI or Service Provider Entity ID.
federationParameters_federationURN :: Lens.Lens' FederationParameters (Prelude.Maybe Prelude.Text)
federationParameters_federationURN :: Lens' FederationParameters (Maybe Text)
federationParameters_federationURN = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FederationParameters' {Maybe Text
federationURN :: Maybe Text
$sel:federationURN:FederationParameters' :: FederationParameters -> Maybe Text
federationURN} -> Maybe Text
federationURN) (\s :: FederationParameters
s@FederationParameters' {} Maybe Text
a -> FederationParameters
s {$sel:federationURN:FederationParameters' :: Maybe Text
federationURN = Maybe Text
a} :: FederationParameters)

-- | SAML 2.0 Metadata document from identity provider (IdP).
federationParameters_samlMetadataDocument :: Lens.Lens' FederationParameters (Prelude.Maybe Prelude.Text)
federationParameters_samlMetadataDocument :: Lens' FederationParameters (Maybe Text)
federationParameters_samlMetadataDocument = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FederationParameters' {Maybe Text
samlMetadataDocument :: Maybe Text
$sel:samlMetadataDocument:FederationParameters' :: FederationParameters -> Maybe Text
samlMetadataDocument} -> Maybe Text
samlMetadataDocument) (\s :: FederationParameters
s@FederationParameters' {} Maybe Text
a -> FederationParameters
s {$sel:samlMetadataDocument:FederationParameters' :: Maybe Text
samlMetadataDocument = Maybe Text
a} :: FederationParameters)

-- | Provide the metadata URL from your SAML 2.0 compliant identity provider
-- (IdP).
federationParameters_samlMetadataURL :: Lens.Lens' FederationParameters (Prelude.Maybe Prelude.Text)
federationParameters_samlMetadataURL :: Lens' FederationParameters (Maybe Text)
federationParameters_samlMetadataURL = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\FederationParameters' {Maybe Text
samlMetadataURL :: Maybe Text
$sel:samlMetadataURL:FederationParameters' :: FederationParameters -> Maybe Text
samlMetadataURL} -> Maybe Text
samlMetadataURL) (\s :: FederationParameters
s@FederationParameters' {} Maybe Text
a -> FederationParameters
s {$sel:samlMetadataURL:FederationParameters' :: Maybe Text
samlMetadataURL = Maybe Text
a} :: FederationParameters)

instance Data.FromJSON FederationParameters where
  parseJSON :: Value -> Parser FederationParameters
parseJSON =
    forall a. String -> (Object -> Parser a) -> Value -> Parser a
Data.withObject
      String
"FederationParameters"
      ( \Object
x ->
          Maybe Text
-> Maybe (HashMap Text Text)
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> Maybe Text
-> FederationParameters
FederationParameters'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"applicationCallBackURL")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"attributeMap" forall a. Parser (Maybe a) -> a -> Parser a
Data..!= forall a. Monoid a => a
Prelude.mempty)
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"federationProviderName")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"federationURN")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"samlMetadataDocument")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (Object
x forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
Data..:? Key
"samlMetadataURL")
      )

instance Prelude.Hashable FederationParameters where
  hashWithSalt :: Int -> FederationParameters -> Int
hashWithSalt Int
_salt FederationParameters' {Maybe Text
Maybe (HashMap Text Text)
samlMetadataURL :: Maybe Text
samlMetadataDocument :: Maybe Text
federationURN :: Maybe Text
federationProviderName :: Maybe Text
attributeMap :: Maybe (HashMap Text Text)
applicationCallBackURL :: Maybe Text
$sel:samlMetadataURL:FederationParameters' :: FederationParameters -> Maybe Text
$sel:samlMetadataDocument:FederationParameters' :: FederationParameters -> Maybe Text
$sel:federationURN:FederationParameters' :: FederationParameters -> Maybe Text
$sel:federationProviderName:FederationParameters' :: FederationParameters -> Maybe Text
$sel:attributeMap:FederationParameters' :: FederationParameters -> Maybe (HashMap Text Text)
$sel:applicationCallBackURL:FederationParameters' :: FederationParameters -> Maybe Text
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
applicationCallBackURL
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe (HashMap Text Text)
attributeMap
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
federationProviderName
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
federationURN
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
samlMetadataDocument
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
samlMetadataURL

instance Prelude.NFData FederationParameters where
  rnf :: FederationParameters -> ()
rnf FederationParameters' {Maybe Text
Maybe (HashMap Text Text)
samlMetadataURL :: Maybe Text
samlMetadataDocument :: Maybe Text
federationURN :: Maybe Text
federationProviderName :: Maybe Text
attributeMap :: Maybe (HashMap Text Text)
applicationCallBackURL :: Maybe Text
$sel:samlMetadataURL:FederationParameters' :: FederationParameters -> Maybe Text
$sel:samlMetadataDocument:FederationParameters' :: FederationParameters -> Maybe Text
$sel:federationURN:FederationParameters' :: FederationParameters -> Maybe Text
$sel:federationProviderName:FederationParameters' :: FederationParameters -> Maybe Text
$sel:attributeMap:FederationParameters' :: FederationParameters -> Maybe (HashMap Text Text)
$sel:applicationCallBackURL:FederationParameters' :: FederationParameters -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
applicationCallBackURL
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe (HashMap Text Text)
attributeMap
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
federationProviderName
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
federationURN
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
samlMetadataDocument
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
samlMetadataURL

instance Data.ToJSON FederationParameters where
  toJSON :: FederationParameters -> Value
toJSON FederationParameters' {Maybe Text
Maybe (HashMap Text Text)
samlMetadataURL :: Maybe Text
samlMetadataDocument :: Maybe Text
federationURN :: Maybe Text
federationProviderName :: Maybe Text
attributeMap :: Maybe (HashMap Text Text)
applicationCallBackURL :: Maybe Text
$sel:samlMetadataURL:FederationParameters' :: FederationParameters -> Maybe Text
$sel:samlMetadataDocument:FederationParameters' :: FederationParameters -> Maybe Text
$sel:federationURN:FederationParameters' :: FederationParameters -> Maybe Text
$sel:federationProviderName:FederationParameters' :: FederationParameters -> Maybe Text
$sel:attributeMap:FederationParameters' :: FederationParameters -> Maybe (HashMap Text Text)
$sel:applicationCallBackURL:FederationParameters' :: FederationParameters -> Maybe Text
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"applicationCallBackURL" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
applicationCallBackURL,
            (Key
"attributeMap" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe (HashMap Text Text)
attributeMap,
            (Key
"federationProviderName" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
federationProviderName,
            (Key
"federationURN" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
federationURN,
            (Key
"samlMetadataDocument" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
samlMetadataDocument,
            (Key
"samlMetadataURL" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=)
              forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
samlMetadataURL
          ]
      )