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

__init__(*, user_pool, attribute_mapping=None, client_id, client_secret, api_version=None, scopes=None)

Properties to initialize UserPoolFacebookIdentityProvider.

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

  • attribute_mapping (Optional[AttributeMapping]) – 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[List[str]]) – The list of facebook permissions to obtain for getting access to the Facebook profile. Default: [ public_profile ]

stability :stability: experimental

Return type

None

Attributes

api_version

The Facebook API version to use.

default :default: - to the oldest version supported by Facebook

stability :stability: experimental

Return type

Optional[str]

attribute_mapping

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

default :default: - no attribute mapping

stability :stability: experimental

Return type

Optional[AttributeMapping]

client_id

The client id recognized by Facebook APIs.

stability :stability: experimental

Return type

str

client_secret

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

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

Return type

str

scopes

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

default :default: [ public_profile ]

see :see: https://developers.facebook.com/docs/facebook-login/permissions stability :stability: experimental

Return type

Optional[List[str]]

user_pool

The user pool to which this construct provides identities.

stability :stability: experimental

Return type

IUserPool