feat(cognito): support emailVerified attribute mapping

aws · Oct 3, 2024 · c17e064 · c17e064
1 parent 0c753c3
commit c17e064
Show file tree

Hide file tree

Showing 10 changed files with 24 additions and 10 deletions.
diff --git a/...esting/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/cdk.out b/...esting/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/cdk.out
diff --git a/...-cognito/test/integ.user-pool-idp.oidc.js.snapshot/integ-user-pool-idp-google.assets.json b/...-cognito/test/integ.user-pool-idp.oidc.js.snapshot/integ-user-pool-idp-google.assets.json
diff --git a/...ognito/test/integ.user-pool-idp.oidc.js.snapshot/integ-user-pool-idp-google.template.json b/...ognito/test/integ.user-pool-idp.oidc.js.snapshot/integ-user-pool-idp-google.template.json
@@ -73,7 +73,8 @@
    "Type": "AWS::Cognito::UserPoolIdentityProvider",
    "Properties": {
     "AttributeMapping": {
-     "phone_number": "phone_number"
+     "phone_number": "phone_number",
+     "email_verified": "email_verified"
     },
     "ProviderDetails": {
      "client_id": "client-id",

diff --git a/...ing/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/integ.json b/...ing/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/integ.json
diff --git a/.../framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/manifest.json b/.../framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/manifest.json
diff --git a/...ting/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/tree.json b/...ting/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.js.snapshot/tree.json
diff --git a/packages/@aws-cdk-testing/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.ts b/packages/@aws-cdk-testing/framework-integ/test/aws-cognito/test/integ.user-pool-idp.oidc.ts
@@ -27,6 +27,7 @@ new UserPoolIdentityProviderOidc(stack, 'cdk', {
   scopes: ['openid', 'phone'],
   attributeMapping: {
     phoneNumber: ProviderAttribute.other('phone_number'),
+    emailVerified: ProviderAttribute.other('email_verified'),
   },
 });
 

diff --git a/packages/aws-cdk-lib/aws-cognito/README.md b/packages/aws-cdk-lib/aws-cognito/README.md
@@ -638,7 +638,9 @@ new cognito.UserPoolIdentityProviderAmazon(this, 'Amazon', {
   userPool: userpool,
   attributeMapping: {
     email: cognito.ProviderAttribute.AMAZON_EMAIL,
-    website: cognito.ProviderAttribute.other('url'), // use other() when an attribute is not pre-defined in the CDK
+    // use other() when an attribute is not pre-defined in the CDK
+    emailVerified: ProviderAttribute.other('email_verified'),
+    website: cognito.ProviderAttribute.other('url'), 
     custom: {
       // custom user pool attributes go here
       uniqueId: cognito.ProviderAttribute.AMAZON_USER_ID,

diff --git a/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/base.ts b/packages/aws-cdk-lib/aws-cognito/lib/user-pool-idps/base.ts
@@ -98,6 +98,12 @@ export interface AttributeMapping {
    */
   readonly email?: ProviderAttribute;
 
+  /**
+   * The user's e-mail address is verification.
+   * @default - not mapped
+   */
+  readonly emailVerified?: ProviderAttribute;
+
   /**
    * The surname or last name of user.
    * @default - not mapped

diff --git a/packages/aws-cdk-lib/aws-cognito/test/user-pool-idps/base.test.ts b/packages/aws-cdk-lib/aws-cognito/test/user-pool-idps/base.test.ts
@@ -39,13 +39,15 @@ describe('UserPoolIdentityProvider', () => {
         attributeMapping: {
           givenName: ProviderAttribute.FACEBOOK_NAME,
           birthdate: ProviderAttribute.FACEBOOK_BIRTHDAY,
+          emailVerified: ProviderAttribute.other('email_verified'),
         },
       });
 
       // THEN
       expect(idp.mapping).toStrictEqual({
         given_name: 'name',
         birthdate: 'birthday',
+        email_verified: 'email_verified',
       });
     });