libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

Description

 
Synopsis

Documentation

data CognitoIdentityProvider Source #

A provider representing an Amazon Cognito user pool and its client ID.

See: newCognitoIdentityProvider smart constructor.

Constructors

CognitoIdentityProvider' 

Fields

  • clientId :: Maybe Text

    The client ID for the Amazon Cognito user pool.

  • serverSideTokenCheck :: Maybe Bool

    TRUE if server-side token validation is enabled for the identity provider’s token.

    Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

    If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

  • providerName :: Maybe Text

    The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

Instances

Instances details
Eq CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

Read CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

Show CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

Generic CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

Associated Types

type Rep CognitoIdentityProvider :: Type -> Type #

NFData CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

Methods

rnf :: CognitoIdentityProvider -> () #

Hashable CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

ToJSON CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

FromJSON CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

type Rep CognitoIdentityProvider Source # 
Instance details

Defined in Amazonka.CognitoIdentity.Types.CognitoIdentityProvider

type Rep CognitoIdentityProvider = D1 ('MetaData "CognitoIdentityProvider" "Amazonka.CognitoIdentity.Types.CognitoIdentityProvider" "libZSservicesZSamazonka-cognito-identityZSamazonka-cognito-identity" 'False) (C1 ('MetaCons "CognitoIdentityProvider'" 'PrefixI 'True) (S1 ('MetaSel ('Just "clientId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "serverSideTokenCheck") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newCognitoIdentityProvider :: CognitoIdentityProvider Source #

Create a value of CognitoIdentityProvider 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:clientId:CognitoIdentityProvider', cognitoIdentityProvider_clientId - The client ID for the Amazon Cognito user pool.

$sel:serverSideTokenCheck:CognitoIdentityProvider', cognitoIdentityProvider_serverSideTokenCheck - TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

$sel:providerName:CognitoIdentityProvider', cognitoIdentityProvider_providerName - The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.

cognitoIdentityProvider_clientId :: Lens' CognitoIdentityProvider (Maybe Text) Source #

The client ID for the Amazon Cognito user pool.

cognitoIdentityProvider_serverSideTokenCheck :: Lens' CognitoIdentityProvider (Maybe Bool) Source #

TRUE if server-side token validation is enabled for the identity provider’s token.

Once you set ServerSideTokenCheck to TRUE for an identity pool, that identity pool will check with the integrated user pools to make sure that the user has not been globally signed out or deleted before the identity pool provides an OIDC token or AWS credentials for the user.

If the user is signed out or deleted, the identity pool will return a 400 Not Authorized error.

cognitoIdentityProvider_providerName :: Lens' CognitoIdentityProvider (Maybe Text) Source #

The provider name for an Amazon Cognito user pool. For example, cognito-idp.us-east-1.amazonaws.com/us-east-1_123456789.