Amazonka.Grafana.Types.SamlConfiguration

Documentation

data SamlConfiguration

A structure containing information about how this workspace works with SAML.

See: newSamlConfiguration smart constructor.

Constructors

SamlConfiguration'

Fields

• allowedOrganizations :: Maybe [Text]

  Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

• assertionAttributes :: Maybe AssertionAttributes

  A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

• loginValidityDuration :: Maybe Int

  How long a sign-on session by a SAML user is valid, before the user has to sign on again.

• roleValues :: Maybe RoleValues

  A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

• idpMetadata :: IdpMetadata

  A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

Instances

FromJSON SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

parseJSON :: Value -> Parser SamlConfiguration

parseJSONList :: Value -> Parser [SamlConfiguration]

ToJSON SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

toJSON :: SamlConfiguration -> Value

toEncoding :: SamlConfiguration -> Encoding

toJSONList :: [SamlConfiguration] -> Value

toEncodingList :: [SamlConfiguration] -> Encoding

Generic SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Associated Types

type Rep SamlConfiguration :: Type -> Type

Methods

from :: SamlConfiguration -> Rep SamlConfiguration x

to :: Rep SamlConfiguration x -> SamlConfiguration

Read SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

readsPrec :: Int -> ReadS SamlConfiguration

readList :: ReadS [SamlConfiguration]

readPrec :: ReadPrec SamlConfiguration

readListPrec :: ReadPrec [SamlConfiguration]

Show SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

showsPrec :: Int -> SamlConfiguration -> ShowS

show :: SamlConfiguration -> String

showList :: [SamlConfiguration] -> ShowS

NFData SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

rnf :: SamlConfiguration -> ()

Eq SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

(==) :: SamlConfiguration -> SamlConfiguration -> Bool

(/=) :: SamlConfiguration -> SamlConfiguration -> Bool

Hashable SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

Methods

hashWithSalt :: Int -> SamlConfiguration -> Int

hash :: SamlConfiguration -> Int

type Rep SamlConfiguration

Defined in Amazonka.Grafana.Types.SamlConfiguration

type Rep SamlConfiguration = D1 ('MetaData "SamlConfiguration" "Amazonka.Grafana.Types.SamlConfiguration" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "SamlConfiguration'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "allowedOrganizations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "assertionAttributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AssertionAttributes))) :*: (S1 ('MetaSel ('Just "loginValidityDuration") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :*: (S1 ('MetaSel ('Just "roleValues") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RoleValues)) :*: S1 ('MetaSel ('Just "idpMetadata") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdpMetadata)))))

newSamlConfiguration

Arguments

:: IdpMetadata

$sel:idpMetadata:SamlConfiguration'

-> SamlConfiguration

Create a value of SamlConfiguration 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:allowedOrganizations:SamlConfiguration', samlConfiguration_allowedOrganizations - Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

$sel:assertionAttributes:SamlConfiguration', samlConfiguration_assertionAttributes - A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

$sel:loginValidityDuration:SamlConfiguration', samlConfiguration_loginValidityDuration - How long a sign-on session by a SAML user is valid, before the user has to sign on again.

$sel:roleValues:SamlConfiguration', samlConfiguration_roleValues - A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

$sel:idpMetadata:SamlConfiguration', samlConfiguration_idpMetadata - A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

samlConfiguration_allowedOrganizations :: Lens' SamlConfiguration (Maybe [Text])

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

samlConfiguration_assertionAttributes :: Lens' SamlConfiguration (Maybe AssertionAttributes)

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

samlConfiguration_loginValidityDuration :: Lens' SamlConfiguration (Maybe Int)

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

samlConfiguration_roleValues :: Lens' SamlConfiguration (Maybe RoleValues)

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

samlConfiguration_idpMetadata :: Lens' SamlConfiguration IdpMetadata

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.