interface UserPoolIdentityProviderAppleProps

Language	Type name
.NET	`Amazon.CDK.AWS.Cognito.UserPoolIdentityProviderAppleProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awscognito#UserPoolIdentityProviderAppleProps`
Java	`software.amazon.awscdk.services.cognito.UserPoolIdentityProviderAppleProps`
Python	`aws_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 * 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

Name	Type	Description
clientId	`string`	The client id recognized by Apple APIs.
keyId	`string`	The keyId (of the same key, which content has to be later supplied as `privateKey`) for Apple APIs to authenticate the client.
teamId	`string`	The teamId for Apple APIs to authenticate the client.
userPool	`IUserPool`	The user pool to which this construct provides identities.
attributeMapping?	`AttributeMapping`	Mapping attributes from the identity provider to standard and custom attributes of the user pool.
privateKey?⚠️	`string`	The privateKey content for Apple APIs to authenticate the client.
privateKeyValue?	`SecretValue`	The privateKey content for Apple APIs to authenticate the client.
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.

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.

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.

privateKey?⚠️

⚠️ Deprecated: use privateKeyValue

Type: string (optional, default: none)

The privateKey content for Apple APIs to authenticate the client.

privateKeyValue?

Type: SecretValue (optional, default: none)

The privateKey content for Apple APIs to authenticate the client.

scopes?

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

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