UserPoolIdentityProviderAppleProps Struct
Properties to initialize UserPoolAppleIdentityProvider.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_cognito as cognito } from 'aws-cdk-lib';
declare const providerAttribute: cognito.ProviderAttribute;
declare const secretValue: cdk.SecretValue;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderAppleProps: cognito.UserPoolIdentityProviderAppleProps = {
clientId: 'clientId',
keyId: 'keyId',
teamId: 'teamId',
userPool: userPool,
// the properties below are optional
attributeMapping: {
address: providerAttribute,
birthdate: providerAttribute,
custom: {
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: ['scopes'],
};
Properties
attributeMappingoptionalAttributeMappingattribute_mappingoptionalAttributeMappingattributeMappingoptionalAttributeMappingAttributeMappingoptionalAttributeMappingAttributeMappingoptionalAttributeMapping#Mapping attributes from the identity provider to standard and custom attributes of the user pool.
Default: no attribute mapping
The client id recognized by Apple APIs.
The keyId (of the same key, which content has to be later supplied as `privateKey`) for Apple APIs to authenticate the client.
privateKeyoptionalstringprivate_keyoptionalstrprivateKeyoptionalStringPrivateKeyoptionalstringPrivateKeyoptional*string= nonedeprecated#use privateKeyValue
privateKeyValueoptionalSecretValueprivate_key_valueoptionalSecretValueprivateKeyValueoptionalSecretValuePrivateKeyValueoptionalSecretValuePrivateKeyValueoptionalSecretValue= none#The privateKey content for Apple APIs to authenticate the client.
scopesoptionalstring[]scopesoptionaltyping.List[str]scopesoptionalList<String>Scopesoptionalstring[]Scopesoptional*[]*string#The list of apple permissions to obtain for getting access to the apple profile.
Default: [ name ]
The teamId for Apple APIs to authenticate the client.