Interface IUserPoolIdentityProviderFacebookProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties to initialize UserPoolFacebookIdentityProvider.

public interface IUserPoolIdentityProviderFacebookProps : IUserPoolIdentityProviderProps

Inherited Members

IUserPoolIdentityProviderProps.UserPool

IUserPoolIdentityProviderProps.AttributeMapping

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.Cognito;

            ProviderAttribute providerAttribute;
            UserPool userPool;

            var userPoolIdentityProviderFacebookProps = new UserPoolIdentityProviderFacebookProps {
                ClientId = "clientId",
                ClientSecret = "clientSecret",
                UserPool = userPool,

                // the properties below are optional
                ApiVersion = "apiVersion",
                AttributeMapping = new AttributeMapping {
                    Address = providerAttribute,
                    Birthdate = providerAttribute,
                    Custom = new Dictionary<string, ProviderAttribute> {
                        { "customKey", providerAttribute }
                    },
                    Email = 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 = new [] { "scopes" }
            };

Remarks

ExampleMetadata: fixture=_generated

Properties

ApiVersion

The Facebook API version to use.

string? ApiVersion { get; }

Property Value

string

Remarks

Default: - to the oldest version supported by Facebook

ClientId

The client id recognized by Facebook APIs.

string ClientId { get; }

Property Value

string

ClientSecret

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

string ClientSecret { get; }

Property Value

string

Remarks

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

Scopes

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

string[]? Scopes { get; }

Property Value

string[]

Remarks

Default: [ public_profile ]

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