Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.Types.IdentityProviderType

Description

Synopsis

data IdentityProviderType = IdentityProviderType' {
- lastModifiedDate :: Maybe POSIX
- userPoolId :: Maybe Text
- providerType :: Maybe IdentityProviderTypeType
- creationDate :: Maybe POSIX
- idpIdentifiers :: Maybe [Text]
- attributeMapping :: Maybe (HashMap Text Text)
- providerDetails :: Maybe (HashMap Text Text)
- providerName :: Maybe Text
}
newIdentityProviderType :: IdentityProviderType
identityProviderType_lastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime)
identityProviderType_userPoolId :: Lens' IdentityProviderType (Maybe Text)
identityProviderType_providerType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType)
identityProviderType_creationDate :: Lens' IdentityProviderType (Maybe UTCTime)
identityProviderType_idpIdentifiers :: Lens' IdentityProviderType (Maybe [Text])
identityProviderType_attributeMapping :: Lens' IdentityProviderType (Maybe (HashMap Text Text))
identityProviderType_providerDetails :: Lens' IdentityProviderType (Maybe (HashMap Text Text))
identityProviderType_providerName :: Lens' IdentityProviderType (Maybe Text)

Documentation

data IdentityProviderType Source #

A container for information about an identity provider.

See: newIdentityProviderType smart constructor.

Constructors

IdentityProviderType'

Fields

lastModifiedDate :: Maybe POSIX
The date the identity provider was last modified.
userPoolId :: Maybe Text
The user pool ID.
providerType :: Maybe IdentityProviderTypeType
The identity provider type.
creationDate :: Maybe POSIX
The date the identity provider was created.
idpIdentifiers :: Maybe [Text]
A list of identity provider identifiers.
attributeMapping :: Maybe (HashMap Text Text)
A mapping of identity provider attributes to standard and custom user pool attributes.
providerDetails :: Maybe (HashMap Text Text)
The identity provider details. The following list describes the provider detail keys for each identity provider type.
- For Google and Login with Amazon:
  - client_id
  - client_secret
  - authorize_scopes
- For Facebook:
  - client_id
  - client_secret
  - authorize_scopes
  - api_version
- For Sign in with Apple:
  - client_id
  - team_id
  - key_id
  - private_key
  - authorize_scopes
- For OIDC providers:
  - client_id
  - client_secret
  - attributes_request_method
  - oidc_issuer
  - authorize_scopes
  - authorize_url /if not available from discovery URL specified by oidc_issuer key/
  - token_url /if not available from discovery URL specified by oidc_issuer key/
  - attributes_url /if not available from discovery URL specified by oidc_issuer key/
  - jwks_uri /if not available from discovery URL specified by oidc_issuer key/
- For SAML providers:
  - MetadataFile OR MetadataURL
  - IDPSignOut optional
providerName :: Maybe Text
The identity provider name.

Instances

Instances details

Eq IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Methods (==) :: IdentityProviderType -> IdentityProviderType -> Bool # (/=) :: IdentityProviderType -> IdentityProviderType -> Bool #
Read IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Methods readsPrec :: Int -> ReadS IdentityProviderType # readList :: ReadS [IdentityProviderType] # readPrec :: ReadPrec IdentityProviderType # readListPrec :: ReadPrec [IdentityProviderType] #
Show IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Methods showsPrec :: Int -> IdentityProviderType -> ShowS # show :: IdentityProviderType -> String # showList :: [IdentityProviderType] -> ShowS #
Generic IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Associated Types type Rep IdentityProviderType :: Type -> Type # Methods from :: IdentityProviderType -> Rep IdentityProviderType x # to :: Rep IdentityProviderType x -> IdentityProviderType #
NFData IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Methods rnf :: IdentityProviderType -> () #
Hashable IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Methods hashWithSalt :: Int -> IdentityProviderType -> Int # hash :: IdentityProviderType -> Int #
FromJSON IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType Methods parseJSON :: Value -> Parser IdentityProviderType # parseJSONList :: Value -> Parser [IdentityProviderType] #
type Rep IdentityProviderType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.IdentityProviderType type Rep IdentityProviderType = D1 ('MetaData "IdentityProviderType" "Amazonka.CognitoIdentityProvider.Types.IdentityProviderType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "IdentityProviderType'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "lastModifiedDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe IdentityProviderTypeType)) :: S1 ('MetaSel ('Just "creationDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)))) :: ((S1 ('MetaSel ('Just "idpIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "attributeMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :: (S1 ('MetaSel ('Just "providerDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIdentityProviderType :: IdentityProviderType Source #

Create a value of IdentityProviderType 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:lastModifiedDate:IdentityProviderType', identityProviderType_lastModifiedDate - The date the identity provider was last modified.

$sel:userPoolId:IdentityProviderType', identityProviderType_userPoolId - The user pool ID.

$sel:providerType:IdentityProviderType', identityProviderType_providerType - The identity provider type.

$sel:creationDate:IdentityProviderType', identityProviderType_creationDate - The date the identity provider was created.

$sel:idpIdentifiers:IdentityProviderType', identityProviderType_idpIdentifiers - A list of identity provider identifiers.

$sel:attributeMapping:IdentityProviderType', identityProviderType_attributeMapping - A mapping of identity provider attributes to standard and custom user pool attributes.

$sel:providerDetails:IdentityProviderType', identityProviderType_providerDetails - The identity provider details. The following list describes the provider detail keys for each identity provider type.

For Google and Login with Amazon:
- client_id
- client_secret
- authorize_scopes
For Facebook:
- client_id
- client_secret
- authorize_scopes
- api_version
For Sign in with Apple:
- client_id
- team_id
- key_id
- private_key
- authorize_scopes
For OIDC providers:
- client_id
- client_secret
- attributes_request_method
- oidc_issuer
- authorize_scopes
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignOut optional

$sel:providerName:IdentityProviderType', identityProviderType_providerName - The identity provider name.

identityProviderType_lastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime) Source #

The date the identity provider was last modified.

identityProviderType_userPoolId :: Lens' IdentityProviderType (Maybe Text) Source #

The user pool ID.

identityProviderType_providerType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType) Source #

The identity provider type.

identityProviderType_creationDate :: Lens' IdentityProviderType (Maybe UTCTime) Source #

The date the identity provider was created.

identityProviderType_idpIdentifiers :: Lens' IdentityProviderType (Maybe [Text]) Source #

A list of identity provider identifiers.

identityProviderType_attributeMapping :: Lens' IdentityProviderType (Maybe (HashMap Text Text)) Source #

A mapping of identity provider attributes to standard and custom user pool attributes.

identityProviderType_providerDetails :: Lens' IdentityProviderType (Maybe (HashMap Text Text)) Source #

The identity provider details. The following list describes the provider detail keys for each identity provider type.

For Google and Login with Amazon:
- client_id
- client_secret
- authorize_scopes
For Facebook:
- client_id
- client_secret
- authorize_scopes
- api_version
For Sign in with Apple:
- client_id
- team_id
- key_id
- private_key
- authorize_scopes
For OIDC providers:
- client_id
- client_secret
- attributes_request_method
- oidc_issuer
- authorize_scopes
- authorize_url /if not available from discovery URL specified by oidc_issuer key/
- token_url /if not available from discovery URL specified by oidc_issuer key/
- attributes_url /if not available from discovery URL specified by oidc_issuer key/
- jwks_uri /if not available from discovery URL specified by oidc_issuer key/
For SAML providers:
- MetadataFile OR MetadataURL
- IDPSignOut optional

identityProviderType_providerName :: Lens' IdentityProviderType (Maybe Text) Source #

The identity provider name.