Custom identities

.fides/db_dataset.yml

@@ -1358,6 +1358,8 @@ dataset:
       data_categories: [user.contact, user.unique_id]
     - name: field_name
       data_categories: [system.operations]
+    - name: field_label
+      data_categories: [system.operations]
     - name: hashed_value
       data_categories: [user.contact, user.unique_id]
     - name: id

CHANGELOG.md

@@ -22,6 +22,7 @@ The types of changes are:
 - Added `getModalLinkLabel` method to global fides object [#4766](https://github.com/ethyca/fides/pull/4766)
 - Added language switcher to fides overlay modal [#4773](https://github.com/ethyca/fides/pull/4773)
 - Added modal link label to experience translation model [#4767](https://github.com/ethyca/fides/pull/4767)
+- Added support for custom identities [#4764](https://github.com/ethyca/fides/pull/4764)
 
 ### Changed
 - Changed the Stripe integration for `Cards` to delete instead of update due to possible issues of a past expiration date [#4768](https://github.com/ethyca/fides/pull/4768)

clients/admin-ui/cypress/fixtures/privacy-requests/list.json

@@ -12,7 +12,10 @@
       "paused_at": null,
       "status": "pending",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "custom_privacy_request_fields": {
         "account_id": { "label": "Account ID", "value": 1 },
         "user_id": { "label": "User ID", "value": "123" },
@@ -61,7 +64,10 @@
       "paused_at": null,
       "status": "pending",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "policy": {
         "name": "default_access_policy",
         "key": "default_access_policy",
@@ -104,7 +110,10 @@
       "paused_at": null,
       "status": "pending",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "policy": {
         "name": "default_access_policy",
         "key": "default_access_policy",
@@ -147,7 +156,10 @@
       "paused_at": null,
       "status": "pending",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "policy": {
         "name": "default_access_policy",
         "key": "default_access_policy",
@@ -190,7 +202,10 @@
       "paused_at": null,
       "status": "complete",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "policy": {
         "name": "default_access_policy",
         "key": "default_access_policy",
@@ -233,7 +248,10 @@
       "paused_at": null,
       "status": "complete",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "policy": {
         "name": "default_access_policy",
         "key": "default_access_policy",
@@ -276,7 +294,10 @@
       "paused_at": null,
       "status": "complete",
       "external_id": null,
-      "identity": { "phone_number": null, "email": "[email protected]" },
+      "identity": {
+        "phone_number": { "label": "Phone number", "value": null },
+        "email": { "label": "Email", "value": "[email protected]" }
+      },
       "policy": {
         "name": "default_access_policy",
         "key": "default_access_policy",
@@ -320,8 +341,8 @@
       "status": "error",
       "external_id": null,
       "identity": {
-        "phone_number": "+14155551234",
-        "email": "[email protected]"
+        "phone_number": { "label": "Phone number", "value": "+14155551234" },
+        "email": { "label": "Email", "value": "[email protected]" }
       },
       "policy": {
         "name": "default_access_policy",

clients/admin-ui/src/features/privacy-requests/ApprovePrivacyRequestModal.tsx

@@ -52,32 +52,31 @@ const ApprovePrivacyRequestModal = ({
             Are you sure you want to approve this privacy request?
           </Text>
           <UnorderedList>
-            {identity.email && (
-              <ListItem>
-                <Flex alignItems="flex-start">
-                  <Text mr={2} fontSize="sm" color="gray.900" fontWeight="500">
-                    Email:
-                  </Text>
-                  <Text color="gray.600" fontWeight="500" fontSize="sm" mr={2}>
-                    {identity.email} (
-                    {identityVerifiedAt ? "Verified" : "Unverified"})
-                  </Text>
-                </Flex>
-              </ListItem>
-            )}
-            {identity.phone_number && (
-              <ListItem>
-                <Flex alignItems="flex-start">
-                  <Text mr={2} fontSize="sm" color="gray.900" fontWeight="500">
-                    Phone Number:
-                  </Text>
-                  <Text color="gray.600" fontWeight="500" fontSize="sm" mr={2}>
-                    {identity.phone_number} (
-                    {identityVerifiedAt ? "Verified" : "Unverified"})
-                  </Text>
-                </Flex>
-              </ListItem>
-            )}
+            {Object.entries(identity)
+              .filter(([, { value }]) => value !== null)
+              .map(([key, { value, label }]) => (
+                <ListItem key={key}>
+                  <Flex key={key} alignItems="flex-start">
+                    <Text
+                      mr={2}
+                      fontSize="sm"
+                      color="gray.900"
+                      fontWeight="500"
+                    >
+                      {label}:
+                    </Text>
+                    <Text
+                      color="gray.600"
+                      fontWeight="500"
+                      fontSize="sm"
+                      mr={2}
+                    >
+                      {value}
+                    </Text>
+                    ({identityVerifiedAt ? "Verified" : "Unverified"})
+                  </Flex>
+                </ListItem>
+              ))}
             {customPrivacyRequestFields &&
               Object.entries(customPrivacyRequestFields)
                 .filter(([, item]) => item.value)
@@ -101,8 +100,8 @@ const ApprovePrivacyRequestModal = ({
                         {Array.isArray(item.value)
                           ? item.value.join(", ")
                           : item.value}{" "}
-                        (Unverified)
                       </Text>
+                      (Unverified)
                     </Flex>
                   </ListItem>
                 ))}

clients/admin-ui/src/features/privacy-requests/RequestDetails.tsx

@@ -29,7 +29,13 @@ const RequestDetails = ({ subjectRequest }: RequestDetailsProps) => {
 
   return (
     <>
-      <Heading color="gray.900" fontSize="lg" fontWeight="semibold" mb={4}>
+      <Heading
+        color="gray.900"
+        fontSize="lg"
+        fontWeight="semibold"
+        mt={4}
+        mb={4}
+      >
         Request details
       </Heading>
       <Divider />

clients/admin-ui/src/features/privacy-requests/RequestRow.tsx

@@ -162,7 +162,9 @@ const RequestRow = ({
           <PII
             data={
               request.identity
-                ? request.identity.email || request.identity.phone_number || ""
+                ? request.identity.email.value ||
+                  request.identity.phone_number.value ||
+                  ""
                 : ""
             }
             revealPII={revealPII}

clients/admin-ui/src/features/privacy-requests/SubjectIdentities.tsx

@@ -36,58 +36,40 @@ const SubjectIdentities = ({ subjectRequest }: SubjectIdentitiesProps) => {
           </Text>
         </Flex>
       </Flex>
-      <Divider />
-
-      {identity.email && (
-        <Flex alignItems="center">
-          <Text
-            mt={4}
-            mb={4}
-            mr={2}
-            fontSize="sm"
-            color="gray.900"
-            fontWeight="500"
-          >
-            Email:
-          </Text>
-          <Text color="gray.600" fontWeight="500" fontSize="sm" mr={2}>
-            <PII
-              data={identity.email ? identity.email : ""}
-              revealPII={revealPII}
-            />
-          </Text>
-          <Tag color="white" bg="primary.400" fontWeight="medium" fontSize="sm">
-            {identityVerifiedAt ? "Verified" : "Unverified"}
-          </Tag>
-        </Flex>
-      )}
-      {identity.phone_number && (
-        <Flex alignItems="flex-start">
-          <Text mb={4} mr={2} fontSize="sm" color="gray.900" fontWeight="500">
-            Mobile:
-          </Text>
-          <Text color="gray.600" fontWeight="500" fontSize="sm">
-            <PII
-              data={identity.phone_number ? identity.phone_number : ""}
-              revealPII={revealPII}
-            />
-          </Text>
-          <Tag color="white" bg="primary.400" fontWeight="medium" fontSize="sm">
-            {identityVerifiedAt ? "Verified" : "Unverified"}
-          </Tag>
-        </Flex>
-      )}
+      <Divider mb={4} />
+      {Object.entries(identity)
+        .filter(([, { value }]) => value !== null)
+        .map(([key, { value, label }]) => (
+          <Flex key={key} alignItems="flex-start">
+            <Text mb={4} mr={2} fontSize="sm" color="gray.900" fontWeight="500">
+              {label}:
+            </Text>
+            <Text color="gray.600" fontWeight="500" fontSize="sm" mr={2}>
+              <PII data={value || ""} revealPII={revealPII} />
+            </Text>
+            <Tag
+              color="white"
+              bg="primary.400"
+              fontWeight="medium"
+              fontSize="sm"
+            >
+              {identityVerifiedAt ? "Verified" : "Unverified"}
+            </Tag>
+          </Flex>
+        ))}
       {customPrivacyRequestFields &&
         Object.keys(customPrivacyRequestFields).length > 0 && (
           <>
             <Heading
               color="gray.900"
-              fontSize="sm"
+              fontSize="lg"
               fontWeight="semibold"
+              mt={4}
               mb={4}
             >
-              Custom privacy request fields
+              Custom request fields
             </Heading>
+            <Divider mb={4} />
             {Object.entries(customPrivacyRequestFields)
               .filter(([, item]) => item.value)
               .map(([key, item]) => (

clients/admin-ui/src/features/privacy-requests/types.ts

@@ -71,8 +71,7 @@ export interface PrivacyRequestEntity {
   status: PrivacyRequestStatus;
   results?: PrivacyRequestResults;
   identity: {
-    email?: string;
-    phone_number?: string;
+    [key: string]: { label: string; value: any };
   };
   identity_verified_at?: string;
   custom_privacy_request_fields?: {

clients/cypress-e2e/cypress/e2e/smoke_test.cy.ts

@@ -19,6 +19,7 @@ describe("Smoke test", () => {
     cy.getByTestId("card").contains("Access your data").click();
     cy.getByTestId("privacy-request-form").within(() => {
       cy.get("input#email").type("[email protected]");
+      cy.get("input#loyalty_id").type("CH-1");
       cy.get("input#first_name").type("Jenny");
       cy.get("input#color").clear().type("blue");
       cy.get("button").contains("Continue").click();
@@ -30,17 +31,13 @@ describe("Smoke test", () => {
         {
           identity: {
             email: "[email protected]",
-            phone_number: "",
+            loyalty_id: { label: "Loyalty ID", value: "CH-1" },
           },
           custom_privacy_request_fields: {
             first_name: {
               label: "First name",
               value: "Jenny",
             },
-            last_name: {
-              label: "Last name",
-              value: "",
-            },
             color: {
               label: "Color",
               value: "blue",