Interface IUserPoolIdentityProviderFacebookProps

Properties to initialize UserPoolFacebookIdentityProvider.

Inherited Members

IUserPoolIdentityProviderProps.UserPool

IUserPoolIdentityProviderProps.AttributeMapping

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IUserPoolIdentityProviderFacebookProps : IUserPoolIdentityProviderProps

Syntax (vb)

Public Interface IUserPoolIdentityProviderFacebookProps
    Inherits IUserPoolIdentityProviderProps

Remarks

ExampleMetadata: fixture=_generated

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" }
};

Synopsis

Properties

ApiVersion	The Facebook API version to use.
ClientId	The client id recognized by Facebook APIs.
ClientSecret	The client secret to be accompanied with clientId for Facebook to authenticate the client.
Scopes	The list of Facebook permissions to obtain for getting access to the Facebook profile.

Properties

ApiVersion

The Facebook API version to use.

virtual string ApiVersion { get; }

Property Value

System.String

Remarks

Default: - to the oldest version supported by Facebook

ClientId

The client id recognized by Facebook APIs.

string ClientId { get; }

Property Value

System.String

ClientSecret

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

string ClientSecret { get; }

Property Value

System.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.

virtual string[] Scopes { get; }

Property Value

System.String[]

Remarks

Default: [ public_profile ]

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