Learn R Programming

paws.security.identity (version 0.4.0)

cognitoidentityprovider_create_identity_provider: Creates an IdP for a user pool

Description

Creates an IdP for a user pool.

See https://www.paws-r-sdk.com/docs/cognitoidentityprovider_create_identity_provider/ for full documentation.

Usage

cognitoidentityprovider_create_identity_provider(
  UserPoolId,
  ProviderName,
  ProviderType,
  ProviderDetails,
  AttributeMapping = NULL,
  IdpIdentifiers = NULL
)

Arguments

UserPoolId

[required] The user pool ID.

ProviderName

[required] The IdP name.

ProviderType

[required] The IdP type.

ProviderDetails

[required] 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

AttributeMapping

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

IdpIdentifiers

A list of IdP identifiers.