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 (
Optional
[AttributeMapping
]) – Mapping attributes from the identity provider to standard and custom attributes of the user pool. Default: - no attribute mappingclient_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 Facebookscopes (
Optional
[List
[str
]]) – The list of facebook permissions to obtain for getting access to the Facebook profile. Default: [ public_profile ]
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
]]