Interface IAttributeMapping
The mapping of user pool attributes to the attributes provided by the identity providers.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface IAttributeMapping
Syntax (vb)
Public Interface IAttributeMapping
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
Properties
Address | The user's postal address is a required attribute. |
Birthdate | The user's birthday. |
Custom | Specify custom attribute mapping here and mapping for any standard attributes not supported yet. |
The user's e-mail address. |
|
FamilyName | The surname or last name of user. |
Fullname | The user's full name in displayable form. |
Gender | The user's gender. |
GivenName | The user's first name or give name. |
LastUpdateTime | Time, the user's information was last updated. |
Locale | The user's locale. |
MiddleName | The user's middle name. |
Nickname | The user's nickname or casual name. |
PhoneNumber | The user's telephone number. |
PreferredUsername | The user's preferred username. |
ProfilePage | The URL to the user's profile page. |
ProfilePicture | The URL to the user's profile picture. |
Timezone | The user's time zone. |
Website | The URL to the user's web page or blog. |
Properties
Address
The user's postal address is a required attribute.
virtual ProviderAttribute Address { get; }
Property Value
Remarks
Default: - not mapped
Birthdate
The user's birthday.
virtual ProviderAttribute Birthdate { get; }
Property Value
Remarks
Default: - not mapped
Custom
Specify custom attribute mapping here and mapping for any standard attributes not supported yet.
virtual IDictionary<string, ProviderAttribute> Custom { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, ProviderAttribute>
Remarks
Default: - no custom attribute mapping
The user's e-mail address.
virtual ProviderAttribute Email { get; }
Property Value
Remarks
Default: - not mapped
FamilyName
The surname or last name of user.
virtual ProviderAttribute FamilyName { get; }
Property Value
Remarks
Default: - not mapped
Fullname
The user's full name in displayable form.
virtual ProviderAttribute Fullname { get; }
Property Value
Remarks
Default: - not mapped
Gender
The user's gender.
virtual ProviderAttribute Gender { get; }
Property Value
Remarks
Default: - not mapped
GivenName
The user's first name or give name.
virtual ProviderAttribute GivenName { get; }
Property Value
Remarks
Default: - not mapped
LastUpdateTime
Time, the user's information was last updated.
virtual ProviderAttribute LastUpdateTime { get; }
Property Value
Remarks
Default: - not mapped
Locale
The user's locale.
virtual ProviderAttribute Locale { get; }
Property Value
Remarks
Default: - not mapped
MiddleName
The user's middle name.
virtual ProviderAttribute MiddleName { get; }
Property Value
Remarks
Default: - not mapped
Nickname
The user's nickname or casual name.
virtual ProviderAttribute Nickname { get; }
Property Value
Remarks
Default: - not mapped
PhoneNumber
The user's telephone number.
virtual ProviderAttribute PhoneNumber { get; }
Property Value
Remarks
Default: - not mapped
PreferredUsername
The user's preferred username.
virtual ProviderAttribute PreferredUsername { get; }
Property Value
Remarks
Default: - not mapped
ProfilePage
The URL to the user's profile page.
virtual ProviderAttribute ProfilePage { get; }
Property Value
Remarks
Default: - not mapped
ProfilePicture
The URL to the user's profile picture.
virtual ProviderAttribute ProfilePicture { get; }
Property Value
Remarks
Default: - not mapped
Timezone
The user's time zone.
virtual ProviderAttribute Timezone { get; }
Property Value
Remarks
Default: - not mapped
Website
The URL to the user's web page or blog.
virtual ProviderAttribute Website { get; }
Property Value
Remarks
Default: - not mapped