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.CreateIdentityProvider

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an identity provider for a user pool.

Synopsis

Creating a Request

data CreateIdentityProvider Source #

See: newCreateIdentityProvider smart constructor.

Constructors

CreateIdentityProvider'

Fields

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.
userPoolId :: Text
The user pool ID.
providerName :: Text
The identity provider name.
providerType :: IdentityProviderTypeType
The identity provider type.
providerDetails :: 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

Instances

Instances details

Eq CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods (==) :: CreateIdentityProvider -> CreateIdentityProvider -> Bool # (/=) :: CreateIdentityProvider -> CreateIdentityProvider -> Bool #
Read CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods readsPrec :: Int -> ReadS CreateIdentityProvider # readList :: ReadS [CreateIdentityProvider] # readPrec :: ReadPrec CreateIdentityProvider # readListPrec :: ReadPrec [CreateIdentityProvider] #
Show CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods showsPrec :: Int -> CreateIdentityProvider -> ShowS # show :: CreateIdentityProvider -> String # showList :: [CreateIdentityProvider] -> ShowS #
Generic CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Associated Types type Rep CreateIdentityProvider :: Type -> Type # Methods from :: CreateIdentityProvider -> Rep CreateIdentityProvider x # to :: Rep CreateIdentityProvider x -> CreateIdentityProvider #
NFData CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods rnf :: CreateIdentityProvider -> () #
Hashable CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods hashWithSalt :: Int -> CreateIdentityProvider -> Int # hash :: CreateIdentityProvider -> Int #
ToJSON CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods toJSON :: CreateIdentityProvider -> Value # toEncoding :: CreateIdentityProvider -> Encoding # toJSONList :: [CreateIdentityProvider] -> Value # toEncodingList :: [CreateIdentityProvider] -> Encoding #
AWSRequest CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Associated Types type AWSResponse CreateIdentityProvider # Methods request :: CreateIdentityProvider -> Request CreateIdentityProvider # response :: MonadResource m => Logger -> Service -> Proxy CreateIdentityProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIdentityProvider))) #
ToHeaders CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods toHeaders :: CreateIdentityProvider -> [Header] #
ToPath CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods toPath :: CreateIdentityProvider -> ByteString #
ToQuery CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods toQuery :: CreateIdentityProvider -> QueryString #
type Rep CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider type Rep CreateIdentityProvider = D1 ('MetaData "CreateIdentityProvider" "Amazonka.CognitoIdentityProvider.CreateIdentityProvider" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "CreateIdentityProvider'" 'PrefixI 'True) ((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 "userPoolId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "providerName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "providerType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityProviderTypeType) :*: S1 ('MetaSel ('Just "providerDetails") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (HashMap Text Text))))))
type AWSResponse CreateIdentityProvider Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider type AWSResponse CreateIdentityProvider = CreateIdentityProviderResponse

newCreateIdentityProvider Source #

Arguments

:: Text	`$sel:userPoolId:CreateIdentityProvider'`
-> Text	`$sel:providerName:CreateIdentityProvider'`
-> IdentityProviderTypeType	`$sel:providerType:CreateIdentityProvider'`
-> CreateIdentityProvider

Create a value of CreateIdentityProvider 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:idpIdentifiers:CreateIdentityProvider', createIdentityProvider_idpIdentifiers - A list of identity provider identifiers.

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

$sel:userPoolId:CreateIdentityProvider', createIdentityProvider_userPoolId - The user pool ID.

$sel:providerName:CreateIdentityProvider', createIdentityProvider_providerName - The identity provider name.

$sel:providerType:CreateIdentityProvider', createIdentityProvider_providerType - The identity provider type.

$sel:providerDetails:CreateIdentityProvider', createIdentityProvider_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

Request Lenses

createIdentityProvider_idpIdentifiers :: Lens' CreateIdentityProvider (Maybe [Text]) Source #

A list of identity provider identifiers.

createIdentityProvider_attributeMapping :: Lens' CreateIdentityProvider (Maybe (HashMap Text Text)) Source #

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

createIdentityProvider_userPoolId :: Lens' CreateIdentityProvider Text Source #

The user pool ID.

createIdentityProvider_providerName :: Lens' CreateIdentityProvider Text Source #

The identity provider name.

createIdentityProvider_providerType :: Lens' CreateIdentityProvider IdentityProviderTypeType Source #

The identity provider type.

createIdentityProvider_providerDetails :: Lens' CreateIdentityProvider (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

Destructuring the Response

data CreateIdentityProviderResponse Source #

See: newCreateIdentityProviderResponse smart constructor.

Constructors

CreateIdentityProviderResponse'
Fields httpStatus :: Int The response's http status code. identityProvider :: IdentityProviderType The newly created identity provider object.

Instances

Instances details

Eq CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods (==) :: CreateIdentityProviderResponse -> CreateIdentityProviderResponse -> Bool # (/=) :: CreateIdentityProviderResponse -> CreateIdentityProviderResponse -> Bool #
Read CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods readsPrec :: Int -> ReadS CreateIdentityProviderResponse # readList :: ReadS [CreateIdentityProviderResponse] # readPrec :: ReadPrec CreateIdentityProviderResponse # readListPrec :: ReadPrec [CreateIdentityProviderResponse] #
Show CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods showsPrec :: Int -> CreateIdentityProviderResponse -> ShowS # show :: CreateIdentityProviderResponse -> String # showList :: [CreateIdentityProviderResponse] -> ShowS #
Generic CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Associated Types type Rep CreateIdentityProviderResponse :: Type -> Type # Methods from :: CreateIdentityProviderResponse -> Rep CreateIdentityProviderResponse x # to :: Rep CreateIdentityProviderResponse x -> CreateIdentityProviderResponse #
NFData CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider Methods rnf :: CreateIdentityProviderResponse -> () #
type Rep CreateIdentityProviderResponse Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider type Rep CreateIdentityProviderResponse = D1 ('MetaData "CreateIdentityProviderResponse" "Amazonka.CognitoIdentityProvider.CreateIdentityProvider" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "CreateIdentityProviderResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: S1 ('MetaSel ('Just "identityProvider") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityProviderType)))

newCreateIdentityProviderResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateIdentityProviderResponse'`
-> IdentityProviderType	`$sel:identityProvider:CreateIdentityProviderResponse'`
-> CreateIdentityProviderResponse

Create a value of CreateIdentityProviderResponse 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:httpStatus:CreateIdentityProviderResponse', createIdentityProviderResponse_httpStatus - The response's http status code.

$sel:identityProvider:CreateIdentityProviderResponse', createIdentityProviderResponse_identityProvider - The newly created identity provider object.

Response Lenses

createIdentityProviderResponse_httpStatus :: Lens' CreateIdentityProviderResponse Int Source #

The response's http status code.

createIdentityProviderResponse_identityProvider :: Lens' CreateIdentityProviderResponse IdentityProviderType Source #

The newly created identity provider object.