Interface IUserPoolIdentityProviderAppleProps

Properties to initialize UserPoolAppleIdentityProvider.

Inherited Members

IUserPoolIdentityProviderProps.AttributeMapping

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface IUserPoolIdentityProviderAppleProps : IUserPoolIdentityProviderProps

Syntax (vb)

Public Interface IUserPoolIdentityProviderAppleProps Inherits IUserPoolIdentityProviderProps

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK;
            using Amazon.CDK.AWS.Cognito;

            ProviderAttribute providerAttribute;
            SecretValue secretValue;
            UserPool userPool;

            var userPoolIdentityProviderAppleProps = new UserPoolIdentityProviderAppleProps {
                ClientId = "clientId",
                KeyId = "keyId",
                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,
                    EmailVerified = 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
                },
                PrivateKey = "privateKey",
                PrivateKeyValue = secretValue,
                Scopes = new [] { "scopes" }
            };

Synopsis

Properties

ClientId	The client id recognized by Apple APIs.
KeyId	The keyId (of the same key, which content has to be later supplied as `privateKey`) for Apple APIs to authenticate the client.
PrivateKey	(deprecated) The privateKey content for Apple APIs to authenticate the client.
PrivateKeyValue	The privateKey content for Apple APIs to authenticate the client.
Scopes	The list of apple permissions to obtain for getting access to the apple profile.
TeamId	The teamId for Apple APIs to authenticate the client.

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

Remarks

ExampleMetadata: fixture=_generated

PrivateKey

(deprecated) The privateKey content for Apple APIs to authenticate the client.

[Obsolete("use privateKeyValue")]
string? PrivateKey { get; }

Property Value

string

Remarks

Default: none

Stability: Deprecated

PrivateKeyValue

The privateKey content for Apple APIs to authenticate the client.

SecretValue? PrivateKeyValue { get; }

Property Value

SecretValue

Remarks

Default: none

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

Remarks

ExampleMetadata: fixture=_generated