Table of Contents

Class ProviderAttribute

Namespace
Amazon.CDK.AWS.Cognito
Assembly
Amazon.CDK.AWS.Cognito.dll

An attribute available from a third party identity provider.

public class ProviderAttribute : DeputyBase
Inheritance
ProviderAttribute

Examples

var userpool = new UserPool(this, "Pool");

            new UserPoolIdentityProviderAmazon(this, "Amazon", new UserPoolIdentityProviderAmazonProps {
                ClientId = "amzn-client-id",
                ClientSecret = "amzn-client-secret",
                UserPool = userpool,
                AttributeMapping = new AttributeMapping {
                    Email = ProviderAttribute.AMAZON_EMAIL,
                    Website = ProviderAttribute.Other("url"),  // use other() when an attribute is not pre-defined in the CDK
                    Custom = new Dictionary<string, ProviderAttribute> {
                        // custom user pool attributes go here
                        { "uniqueId", ProviderAttribute.AMAZON_USER_ID }
                    }
                }
            });

Remarks

ExampleMetadata: infused

Properties

AMAZON_EMAIL

The email attribute provided by Amazon.

public static ProviderAttribute AMAZON_EMAIL { get; }

Property Value

ProviderAttribute

AMAZON_NAME

The name attribute provided by Amazon.

public static ProviderAttribute AMAZON_NAME { get; }

Property Value

ProviderAttribute

AMAZON_POSTAL_CODE

The postal code attribute provided by Amazon.

public static ProviderAttribute AMAZON_POSTAL_CODE { get; }

Property Value

ProviderAttribute

AMAZON_USER_ID

The user id attribute provided by Amazon.

public static ProviderAttribute AMAZON_USER_ID { get; }

Property Value

ProviderAttribute

APPLE_EMAIL

The email attribute provided by Apple.

public static ProviderAttribute APPLE_EMAIL { get; }

Property Value

ProviderAttribute

APPLE_FIRST_NAME

The first name attribute provided by Apple.

public static ProviderAttribute APPLE_FIRST_NAME { get; }

Property Value

ProviderAttribute

APPLE_LAST_NAME

The last name attribute provided by Apple.

public static ProviderAttribute APPLE_LAST_NAME { get; }

Property Value

ProviderAttribute

APPLE_NAME

The name attribute provided by Apple.

public static ProviderAttribute APPLE_NAME { get; }

Property Value

ProviderAttribute

AttributeName

The attribute value string as recognized by the provider.

public virtual string AttributeName { get; }

Property Value

string

FACEBOOK_BIRTHDAY

The birthday attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_BIRTHDAY { get; }

Property Value

ProviderAttribute

FACEBOOK_EMAIL

The email attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_EMAIL { get; }

Property Value

ProviderAttribute

FACEBOOK_FIRST_NAME

The first name attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_FIRST_NAME { get; }

Property Value

ProviderAttribute

FACEBOOK_GENDER

The gender attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_GENDER { get; }

Property Value

ProviderAttribute

FACEBOOK_ID

The user id attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_ID { get; }

Property Value

ProviderAttribute

FACEBOOK_LAST_NAME

The last name attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_LAST_NAME { get; }

Property Value

ProviderAttribute

FACEBOOK_LOCALE

The locale attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_LOCALE { get; }

Property Value

ProviderAttribute

FACEBOOK_MIDDLE_NAME

The middle name attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_MIDDLE_NAME { get; }

Property Value

ProviderAttribute

FACEBOOK_NAME

The name attribute provided by Facebook.

public static ProviderAttribute FACEBOOK_NAME { get; }

Property Value

ProviderAttribute

GOOGLE_BIRTHDAYS

The birthday attribute provided by Google.

public static ProviderAttribute GOOGLE_BIRTHDAYS { get; }

Property Value

ProviderAttribute

GOOGLE_EMAIL

The email attribute provided by Google.

public static ProviderAttribute GOOGLE_EMAIL { get; }

Property Value

ProviderAttribute

GOOGLE_FAMILY_NAME

The family name attribute provided by Google.

public static ProviderAttribute GOOGLE_FAMILY_NAME { get; }

Property Value

ProviderAttribute

GOOGLE_GENDER

The gender attribute provided by Google.

public static ProviderAttribute GOOGLE_GENDER { get; }

Property Value

ProviderAttribute

GOOGLE_GIVEN_NAME

The given name attribute provided by Google.

public static ProviderAttribute GOOGLE_GIVEN_NAME { get; }

Property Value

ProviderAttribute

GOOGLE_NAME

The name attribute provided by Google.

public static ProviderAttribute GOOGLE_NAME { get; }

Property Value

ProviderAttribute

GOOGLE_NAMES

The name attribute provided by Google.

public static ProviderAttribute GOOGLE_NAMES { get; }

Property Value

ProviderAttribute

GOOGLE_PHONE_NUMBERS

The phone number attribute provided by Google.

public static ProviderAttribute GOOGLE_PHONE_NUMBERS { get; }

Property Value

ProviderAttribute

GOOGLE_PICTURE

The picture attribute provided by Google.

public static ProviderAttribute GOOGLE_PICTURE { get; }

Property Value

ProviderAttribute

Methods

Other(string)

Use this to specify an attribute from the identity provider that is not pre-defined in the CDK.

public static ProviderAttribute Other(string attributeName)

Parameters

attributeName string

the attribute value string as recognized by the provider.

Returns

ProviderAttribute