Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Creates an IdP for a user pool.

Creating a Request

data CreateIdentityProvider

See: newCreateIdentityProvider smart constructor.

Constructors

CreateIdentityProvider'

Fields

• attributeMapping :: Maybe (HashMap Text Text)

  A mapping of IdP attributes to standard and custom user pool attributes.

• idpIdentifiers :: Maybe [Text]

  A list of IdP identifiers.

• userPoolId :: Text

  The user pool ID.

• providerName :: Text

  The IdP name.

• providerType :: IdentityProviderTypeType

  The IdP type.

• providerDetails :: HashMap Text Text

  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
    • authorize_scopes

  • For OpenID Connect (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

Instances

ToJSON CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

toJSON :: CreateIdentityProvider -> Value

toEncoding :: CreateIdentityProvider -> Encoding

toJSONList :: [CreateIdentityProvider] -> Value

toEncodingList :: [CreateIdentityProvider] -> Encoding

ToHeaders CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

toHeaders :: CreateIdentityProvider -> [Header]

ToPath CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

toPath :: CreateIdentityProvider -> ByteString

ToQuery CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

toQuery :: CreateIdentityProvider -> QueryString

AWSRequest CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Associated Types

type AWSResponse CreateIdentityProvider

Methods

request :: (Service -> Service) -> CreateIdentityProvider -> Request CreateIdentityProvider

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateIdentityProvider -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateIdentityProvider)))

Generic CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Associated Types

type Rep CreateIdentityProvider :: Type -> Type

Methods

from :: CreateIdentityProvider -> Rep CreateIdentityProvider x

to :: Rep CreateIdentityProvider x -> CreateIdentityProvider

Read CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

readsPrec :: Int -> ReadS CreateIdentityProvider

readList :: ReadS [CreateIdentityProvider]

readPrec :: ReadPrec CreateIdentityProvider

readListPrec :: ReadPrec [CreateIdentityProvider]

Show CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

showsPrec :: Int -> CreateIdentityProvider -> ShowS

show :: CreateIdentityProvider -> String

showList :: [CreateIdentityProvider] -> ShowS

NFData CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

rnf :: CreateIdentityProvider -> ()

Eq CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

(==) :: CreateIdentityProvider -> CreateIdentityProvider -> Bool

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

Hashable CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

hashWithSalt :: Int -> CreateIdentityProvider -> Int

hash :: CreateIdentityProvider -> Int

type AWSResponse CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

type AWSResponse CreateIdentityProvider = CreateIdentityProviderResponse

type Rep CreateIdentityProvider

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

type Rep CreateIdentityProvider = D1 ('MetaData "CreateIdentityProvider" "Amazonka.CognitoIdentityProvider.CreateIdentityProvider" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" 'False) (C1 ('MetaCons "CreateIdentityProvider'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "attributeMapping") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "idpIdentifiers") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [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))))))

newCreateIdentityProvider

Arguments

:: Text

CreateIdentityProvider

-> Text

CreateIdentityProvider

-> IdentityProviderTypeType

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:

CreateIdentityProvider, createIdentityProvider_attributeMapping - A mapping of IdP attributes to standard and custom user pool attributes.

CreateIdentityProvider, createIdentityProvider_idpIdentifiers - A list of IdP identifiers.

CreateIdentityProvider, createIdentityProvider_userPoolId - The user pool ID.

CreateIdentityProvider, createIdentityProvider_providerName - The IdP name.

CreateIdentityProvider, createIdentityProvider_providerType - The IdP type.

CreateIdentityProvider, createIdentityProvider_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
  • authorize_scopes

• For OpenID Connect (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

Request Lenses

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

A mapping of IdP attributes to standard and custom user pool attributes.

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

A list of IdP identifiers.

createIdentityProvider_userPoolId :: Lens' CreateIdentityProvider Text

The user pool ID.

createIdentityProvider_providerName :: Lens' CreateIdentityProvider Text

The IdP name.

createIdentityProvider_providerType :: Lens' CreateIdentityProvider IdentityProviderTypeType

The IdP type.

createIdentityProvider_providerDetails :: Lens' CreateIdentityProvider (HashMap Text Text)

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
  • authorize_scopes

• For OpenID Connect (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

Destructuring the Response

data CreateIdentityProviderResponse

See: newCreateIdentityProviderResponse smart constructor.

Constructors

CreateIdentityProviderResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• identityProvider :: IdentityProviderType

  The newly created IdP object.

Instances

Generic CreateIdentityProviderResponse

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Associated Types

type Rep CreateIdentityProviderResponse :: Type -> Type

Methods

from :: CreateIdentityProviderResponse -> Rep CreateIdentityProviderResponse x

to :: Rep CreateIdentityProviderResponse x -> CreateIdentityProviderResponse

Read CreateIdentityProviderResponse

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

readsPrec :: Int -> ReadS CreateIdentityProviderResponse

readList :: ReadS [CreateIdentityProviderResponse]

readPrec :: ReadPrec CreateIdentityProviderResponse

readListPrec :: ReadPrec [CreateIdentityProviderResponse]

Show CreateIdentityProviderResponse

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

showsPrec :: Int -> CreateIdentityProviderResponse -> ShowS

show :: CreateIdentityProviderResponse -> String

showList :: [CreateIdentityProviderResponse] -> ShowS

NFData CreateIdentityProviderResponse

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

rnf :: CreateIdentityProviderResponse -> ()

Eq CreateIdentityProviderResponse

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

Methods

(==) :: CreateIdentityProviderResponse -> CreateIdentityProviderResponse -> Bool

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

type Rep CreateIdentityProviderResponse

Defined in Amazonka.CognitoIdentityProvider.CreateIdentityProvider

type Rep CreateIdentityProviderResponse = D1 ('MetaData "CreateIdentityProviderResponse" "Amazonka.CognitoIdentityProvider.CreateIdentityProvider" "amazonka-cognito-idp-2.0-D1ERgMvEVPG9z8cOLXdU2" '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

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 IdP object.

Response Lenses

createIdentityProviderResponse_httpStatus :: Lens' CreateIdentityProviderResponse Int

The response's http status code.

createIdentityProviderResponse_identityProvider :: Lens' CreateIdentityProviderResponse IdentityProviderType

The newly created IdP object.