UserPoolIdentityProviderFacebookProps Struct
Properties to initialize UserPoolFacebookIdentityProvider.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';
declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderFacebookProps: cognito.UserPoolIdentityProviderFacebookProps = {
clientId: 'clientId',
clientSecret: 'clientSecret',
userPool: userPool,
// the properties below are optional
apiVersion: 'apiVersion',
attributeMapping: {
address: providerAttribute,
birthdate: providerAttribute,
custom: {
customKey: providerAttribute,
},
email: providerAttribute,
emailVerified: providerAttribute,
familyName: providerAttribute,
fullname: providerAttribute,
gender: providerAttribute,
givenName: providerAttribute,
lastUpdateTime: providerAttribute,
locale: providerAttribute,
middleName: providerAttribute,
nickname: providerAttribute,
phoneNumber: providerAttribute,
preferredUsername: providerAttribute,
profilePage: providerAttribute,
profilePicture: providerAttribute,
timezone: providerAttribute,
website: providerAttribute,
},
scopes: ['scopes'],
};
Properties
apiVersionstringapi_versionstrapiVersionStringApiVersionstringApiVersion*string= to the oldest version supported …#The Facebook API version to use.
default
Default: to the oldest version supported by Facebook
attributeMappingAttributeMappingattribute_mappingAttributeMappingattributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMappingAttributeMapping= no attribute mapping#Mapping attributes from the identity provider to standard and custom attributes of the user pool.
The client id recognized by Facebook APIs.
The client secret to be accompanied with clientId for Facebook to authenticate the client.
scopesstring[]scopestyping.List[str]scopesList<String>Scopesstring[]Scopes*[]*string= [ public_profile ]#The list of Facebook permissions to obtain for getting access to the Facebook profile.