Interface IUserPoolIdentityProviderAppleProps

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Properties to initialize UserPoolAppleIdentityProvider.

public interface IUserPoolIdentityProviderAppleProps : IUserPoolIdentityProviderProps

Inherited Members

IUserPoolIdentityProviderProps.UserPool

IUserPoolIdentityProviderProps.AttributeMapping

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

Properties

ClientId

The client id recognized by Apple APIs.

string ClientId { get; }

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.

string KeyId { get; }

Property Value

string

PrivateKey

The privateKey content for Apple APIs to authenticate the client.

string PrivateKey { get; }

Property Value

string

Scopes

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

string[]? Scopes { get; }

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.

string TeamId { get; }

Property Value

string