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 |
Synopsis
- data IdentityProviderType = IdentityProviderType' {}
- newIdentityProviderType :: IdentityProviderType
- identityProviderType_attributeMapping :: Lens' IdentityProviderType (Maybe (HashMap Text Text))
- identityProviderType_creationDate :: Lens' IdentityProviderType (Maybe UTCTime)
- identityProviderType_idpIdentifiers :: Lens' IdentityProviderType (Maybe [Text])
- identityProviderType_lastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime)
- identityProviderType_providerDetails :: Lens' IdentityProviderType (Maybe (HashMap Text Text))
- identityProviderType_providerName :: Lens' IdentityProviderType (Maybe Text)
- identityProviderType_providerType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType)
- identityProviderType_userPoolId :: Lens' IdentityProviderType (Maybe Text)
Documentation
data IdentityProviderType Source #
A container for information about an IdP.
See: newIdentityProviderType
smart constructor.
IdentityProviderType' | |
|
Instances
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:attributeMapping:IdentityProviderType'
, identityProviderType_attributeMapping
- A mapping of IdP attributes to standard and custom user pool attributes.
$sel:creationDate:IdentityProviderType'
, identityProviderType_creationDate
- The date the IdP was created.
$sel:idpIdentifiers:IdentityProviderType'
, identityProviderType_idpIdentifiers
- A list of IdP identifiers.
$sel:lastModifiedDate:IdentityProviderType'
, identityProviderType_lastModifiedDate
- The date the IdP was last modified.
$sel:providerDetails:IdentityProviderType'
, identityProviderType_providerDetails
- The IdP details. The following list describes the provider detail keys
for each IdP 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
/You can submit a private_key when you add or update an IdP. Describe operations don't return the private key./
- authorize_scopes
For OIDC providers:
- client_id
- client_secret
- attributes_request_method
- oidc_issuer
- authorize_scopes
The following keys are only present if Amazon Cognito didn't discover them at the
oidc_issuer
URL.- authorize_url
- token_url
- attributes_url
- jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
- attributes_url_add_attributes
For SAML providers:
- MetadataFile or MetadataURL
- IDPSignout optional
$sel:providerName:IdentityProviderType'
, identityProviderType_providerName
- The IdP name.
$sel:providerType:IdentityProviderType'
, identityProviderType_providerType
- The IdP type.
$sel:userPoolId:IdentityProviderType'
, identityProviderType_userPoolId
- The user pool ID.
identityProviderType_attributeMapping :: Lens' IdentityProviderType (Maybe (HashMap Text Text)) Source #
A mapping of IdP attributes to standard and custom user pool attributes.
identityProviderType_creationDate :: Lens' IdentityProviderType (Maybe UTCTime) Source #
The date the IdP was created.
identityProviderType_idpIdentifiers :: Lens' IdentityProviderType (Maybe [Text]) Source #
A list of IdP identifiers.
identityProviderType_lastModifiedDate :: Lens' IdentityProviderType (Maybe UTCTime) Source #
The date the IdP was last modified.
identityProviderType_providerDetails :: Lens' IdentityProviderType (Maybe (HashMap Text Text)) Source #
The IdP details. The following list describes the provider detail keys for each IdP 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
/You can submit a private_key when you add or update an IdP. Describe operations don't return the private key./
- authorize_scopes
For OIDC providers:
- client_id
- client_secret
- attributes_request_method
- oidc_issuer
- authorize_scopes
The following keys are only present if Amazon Cognito didn't discover them at the
oidc_issuer
URL.- authorize_url
- token_url
- attributes_url
- jwks_uri
Amazon Cognito sets the value of the following keys automatically. They are read-only.
- attributes_url_add_attributes
For SAML providers:
- MetadataFile or MetadataURL
- IDPSignout optional
identityProviderType_providerName :: Lens' IdentityProviderType (Maybe Text) Source #
The IdP name.
identityProviderType_providerType :: Lens' IdentityProviderType (Maybe IdentityProviderTypeType) Source #
The IdP type.
identityProviderType_userPoolId :: Lens' IdentityProviderType (Maybe Text) Source #
The user pool ID.