Interface IUserPoolIdentityProviderAppleProps
Properties to initialize UserPoolAppleIdentityProvider.
Inherited Members
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,
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 | (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
System.String
Remarks
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
System.String
PrivateKey
(deprecated) The privateKey content for Apple APIs to authenticate the client.
virtual string PrivateKey { get; }
Property Value
System.String
Remarks
Default: none
Stability: Deprecated
PrivateKeyValue
The privateKey content for Apple APIs to authenticate the client.
virtual SecretValue PrivateKeyValue { get; }
Property Value
Remarks
Default: none
Scopes
The list of apple permissions to obtain for getting access to the apple profile.
virtual string[] Scopes { get; }
Property Value
System.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
System.String