UserPoolIdentityProviderFacebookProps

class aws_cdk.aws_cognito.UserPoolIdentityProviderFacebookProps(*, user_pool, attribute_mapping=None, client_id, client_secret, api_version=None, scopes=None)

Bases: aws_cdk.aws_cognito.UserPoolIdentityProviderProps

Properties to initialize UserPoolFacebookIdentityProvider.

Parameters
  • user_pool (IUserPool) – The user pool to which this construct provides identities.

  • attribute_mapping (Union[AttributeMapping, Dict[str, Any], None]) – Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mapping

  • client_id (str) – The client id recognized by Facebook APIs.

  • client_secret (str) – The client secret to be accompanied with clientUd for Facebook to authenticate the client.

  • api_version (Optional[str]) – The Facebook API version to use. Default: - to the oldest version supported by Facebook

  • scopes (Optional[Sequence[str]]) – The list of facebook permissions to obtain for getting access to the Facebook profile. Default: [ public_profile ]

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_cognito as cognito

# provider_attribute: cognito.ProviderAttribute
# user_pool: cognito.UserPool

user_pool_identity_provider_facebook_props = cognito.UserPoolIdentityProviderFacebookProps(
    client_id="clientId",
    client_secret="clientSecret",
    user_pool=user_pool,

    # the properties below are optional
    api_version="apiVersion",
    attribute_mapping=cognito.AttributeMapping(
        address=provider_attribute,
        birthdate=provider_attribute,
        custom={
            "custom_key": provider_attribute
        },
        email=provider_attribute,
        family_name=provider_attribute,
        fullname=provider_attribute,
        gender=provider_attribute,
        given_name=provider_attribute,
        last_update_time=provider_attribute,
        locale=provider_attribute,
        middle_name=provider_attribute,
        nickname=provider_attribute,
        phone_number=provider_attribute,
        preferred_username=provider_attribute,
        profile_page=provider_attribute,
        profile_picture=provider_attribute,
        timezone=provider_attribute,
        website=provider_attribute
    ),
    scopes=["scopes"]
)

Attributes

api_version

The Facebook API version to use.

Default
  • to the oldest version supported by Facebook

Return type

Optional[str]

attribute_mapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

Default
  • no attribute mapping

Return type

Optional[AttributeMapping]

client_id

The client id recognized by Facebook APIs.

Return type

str

client_secret

The client secret to be accompanied with clientUd for Facebook to authenticate the client.

See

https://developers.facebook.com/docs/facebook-login/security#appsecret

Return type

str

scopes

The list of facebook permissions to obtain for getting access to the Facebook profile.

Default

[ public_profile ]

See

https://developers.facebook.com/docs/facebook-login/permissions

Return type

Optional[List[str]]

user_pool

The user pool to which this construct provides identities.

Return type

IUserPool