Class UserPoolIdentityProviderAppleProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties to initialize UserPoolAppleIdentityProvider.

public class UserPoolIdentityProviderAppleProps : IUserPoolIdentityProviderAppleProps, IUserPoolIdentityProviderProps

Inheritance

object

UserPoolIdentityProviderAppleProps

Implements

IUserPoolIdentityProviderAppleProps

IUserPoolIdentityProviderProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

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 userPoolIdentityProviderAppleProps = new UserPoolIdentityProviderAppleProps {
                ClientId = "clientId",
                KeyId = "keyId",
                PrivateKey = "privateKey",
                TeamId = "teamId",
                UserPool = userPool,

                // the properties below are optional
                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

Constructors

UserPoolIdentityProviderAppleProps()

public UserPoolIdentityProviderAppleProps()

Properties

AttributeMapping

Mapping attributes from the identity provider to standard and custom attributes of the user pool.

public IAttributeMapping? AttributeMapping { get; set; }

Property Value

IAttributeMapping

Remarks

Default: - no attribute mapping

ClientId

The client id recognized by Apple APIs.

public string ClientId { get; set; }

Property Value

string

Remarks

See: https://developer.apple.com/documentation/sign_in_with_apple/clientconfigi/3230948-clientid

KeyId

The keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.

public string KeyId { get; set; }

Property Value

string

PrivateKey

The privateKey content for Apple APIs to authenticate the client.

public string PrivateKey { get; set; }

Property Value

string

Scopes

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

public string[]? Scopes { get; set; }

Property Value

string[]

Remarks

Default: [ name ]

See: https://developer.apple.com/documentation/sign_in_with_apple/clientconfigi/3230955-scope

TeamId

The teamId for Apple APIs to authenticate the client.

public string TeamId { get; set; }

Property Value

string

UserPool

The user pool to which this construct provides identities.

public IUserPool UserPool { get; set; }

Property Value

IUserPool