Class ProviderAttribute
An attribute available from a third party identity provider.
Inheritance
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public class ProviderAttribute : DeputyBase
Syntax (vb)
Public Class ProviderAttribute
Inherits DeputyBase
Remarks
ExampleMetadata: infused
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 }
}
}
});
Synopsis
Constructors
ProviderAttribute(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
ProviderAttribute(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
Properties
AMAZON_EMAIL | The email attribute provided by Amazon. |
AMAZON_NAME | The name attribute provided by Amazon. |
AMAZON_POSTAL_CODE | The postal code attribute provided by Amazon. |
AMAZON_USER_ID | The user id attribute provided by Amazon. |
APPLE_EMAIL | The email attribute provided by Apple. |
APPLE_FIRST_NAME | The first name attribute provided by Apple. |
APPLE_LAST_NAME | The last name attribute provided by Apple. |
APPLE_NAME | The name attribute provided by Apple. |
AttributeName | The attribute value string as recognized by the provider. |
FACEBOOK_BIRTHDAY | The birthday attribute provided by Facebook. |
FACEBOOK_EMAIL | The email attribute provided by Facebook. |
FACEBOOK_FIRST_NAME | The first name attribute provided by Facebook. |
FACEBOOK_GENDER | The gender attribute provided by Facebook. |
FACEBOOK_ID | The user id attribute provided by Facebook. |
FACEBOOK_LAST_NAME | The last name attribute provided by Facebook. |
FACEBOOK_LOCALE | The locale attribute provided by Facebook. |
FACEBOOK_MIDDLE_NAME | The middle name attribute provided by Facebook. |
FACEBOOK_NAME | The name attribute provided by Facebook. |
GOOGLE_BIRTHDAYS | The birthday attribute provided by Google. |
GOOGLE_EMAIL | The email attribute provided by Google. |
GOOGLE_FAMILY_NAME | The family name attribute provided by Google. |
GOOGLE_GENDER | The gender attribute provided by Google. |
GOOGLE_GIVEN_NAME | The given name attribute provided by Google. |
GOOGLE_NAME | The name attribute provided by Google. |
GOOGLE_NAMES | The name attribute provided by Google. |
GOOGLE_PHONE_NUMBERS | The phone number attribute provided by Google. |
GOOGLE_PICTURE | The picture attribute provided by Google. |
Methods
Other(String) | Use this to specify an attribute from the identity provider that is not pre-defined in the CDK. |
Constructors
ProviderAttribute(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected ProviderAttribute(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
ProviderAttribute(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected ProviderAttribute(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
Properties
AMAZON_EMAIL
The email attribute provided by Amazon.
public static ProviderAttribute AMAZON_EMAIL { get; }
Property Value
AMAZON_NAME
The name attribute provided by Amazon.
public static ProviderAttribute AMAZON_NAME { get; }
Property Value
AMAZON_POSTAL_CODE
The postal code attribute provided by Amazon.
public static ProviderAttribute AMAZON_POSTAL_CODE { get; }
Property Value
AMAZON_USER_ID
The user id attribute provided by Amazon.
public static ProviderAttribute AMAZON_USER_ID { get; }
Property Value
APPLE_EMAIL
The email attribute provided by Apple.
public static ProviderAttribute APPLE_EMAIL { get; }
Property Value
APPLE_FIRST_NAME
The first name attribute provided by Apple.
public static ProviderAttribute APPLE_FIRST_NAME { get; }
Property Value
APPLE_LAST_NAME
The last name attribute provided by Apple.
public static ProviderAttribute APPLE_LAST_NAME { get; }
Property Value
APPLE_NAME
The name attribute provided by Apple.
public static ProviderAttribute APPLE_NAME { get; }
Property Value
AttributeName
The attribute value string as recognized by the provider.
public virtual string AttributeName { get; }
Property Value
System.String
FACEBOOK_BIRTHDAY
The birthday attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_BIRTHDAY { get; }
Property Value
FACEBOOK_EMAIL
The email attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_EMAIL { get; }
Property Value
FACEBOOK_FIRST_NAME
The first name attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_FIRST_NAME { get; }
Property Value
FACEBOOK_GENDER
The gender attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_GENDER { get; }
Property Value
FACEBOOK_ID
The user id attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_ID { get; }
Property Value
FACEBOOK_LAST_NAME
The last name attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_LAST_NAME { get; }
Property Value
FACEBOOK_LOCALE
The locale attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_LOCALE { get; }
Property Value
FACEBOOK_MIDDLE_NAME
The middle name attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_MIDDLE_NAME { get; }
Property Value
FACEBOOK_NAME
The name attribute provided by Facebook.
public static ProviderAttribute FACEBOOK_NAME { get; }
Property Value
GOOGLE_BIRTHDAYS
The birthday attribute provided by Google.
public static ProviderAttribute GOOGLE_BIRTHDAYS { get; }
Property Value
GOOGLE_EMAIL
The email attribute provided by Google.
public static ProviderAttribute GOOGLE_EMAIL { get; }
Property Value
GOOGLE_FAMILY_NAME
The family name attribute provided by Google.
public static ProviderAttribute GOOGLE_FAMILY_NAME { get; }
Property Value
GOOGLE_GENDER
The gender attribute provided by Google.
public static ProviderAttribute GOOGLE_GENDER { get; }
Property Value
GOOGLE_GIVEN_NAME
The given name attribute provided by Google.
public static ProviderAttribute GOOGLE_GIVEN_NAME { get; }
Property Value
GOOGLE_NAME
The name attribute provided by Google.
public static ProviderAttribute GOOGLE_NAME { get; }
Property Value
GOOGLE_NAMES
The name attribute provided by Google.
public static ProviderAttribute GOOGLE_NAMES { get; }
Property Value
GOOGLE_PHONE_NUMBERS
The phone number attribute provided by Google.
public static ProviderAttribute GOOGLE_PHONE_NUMBERS { get; }
Property Value
GOOGLE_PICTURE
The picture attribute provided by Google.
public static ProviderAttribute GOOGLE_PICTURE { get; }
Property Value
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 System.String
the attribute value string as recognized by the provider.
Returns