aws-cdk-lib.aws_cognito.UserPoolIdentityProviderAppleProps

interface UserPoolIdentityProviderAppleProps

LanguageType name
.NETAmazon.CDK.AWS.Cognito.UserPoolIdentityProviderAppleProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderAppleProps
Javasoftware.amazon.awscdk.services.cognito.UserPoolIdentityProviderAppleProps
Pythonaws_cdk.aws_cognito.UserPoolIdentityProviderAppleProps
TypeScript (source)aws-cdk-lib » aws_cognito » UserPoolIdentityProviderAppleProps

Properties to initialize UserPoolAppleIdentityProvider.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from 'aws-cdk-lib';

declare const providerAttribute: cognito.ProviderAttribute;
declare const userPool: cognito.UserPool;
const userPoolIdentityProviderAppleProps: cognito.UserPoolIdentityProviderAppleProps = {
  clientId: 'clientId',
  keyId: 'keyId',
  privateKey: 'privateKey',
  teamId: 'teamId',
  userPool: userPool,

  // the properties below are optional
  attributeMapping: {
    address: providerAttribute,
    birthdate: providerAttribute,
    custom: {
      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: ['scopes'],
};

Properties

NameTypeDescription
clientIdstringThe client id recognized by Apple APIs.
keyIdstringThe keyId (of the same key, which content has to be later supplied as privateKey) for Apple APIs to authenticate the client.
privateKeystringThe privateKey content for Apple APIs to authenticate the client.
teamIdstringThe teamId for Apple APIs to authenticate the client.
userPoolIUserPoolThe user pool to which this construct provides identities.
attributeMapping?AttributeMappingMapping attributes from the identity provider to standard and custom attributes of the user pool.
scopes?string[]The list of apple permissions to obtain for getting access to the apple profile.

clientId

Type: string

The client id recognized by Apple APIs.

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


keyId

Type: string

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


privateKey

Type: string

The privateKey content for Apple APIs to authenticate the client.


teamId

Type: string

The teamId for Apple APIs to authenticate the client.


userPool

Type: IUserPool

The user pool to which this construct provides identities.


attributeMapping?

Type: AttributeMapping (optional, default: no attribute mapping)

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


scopes?

Type: string[] (optional, default: [ name ])

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

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