Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Segment Integration: user_id over email #5004

Merged
merged 7 commits into from
Jul 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@ The types of changes are:
- Serve GVL languages as they are requested [#5112](https://github.com/ethyca/fides/pull/5112)
- Changed text on system integrations tab to direct to new integration management [#5097](https://github.com/ethyca/fides/pull/5097)
- Updates to consent experience styling [#5085](https://github.com/ethyca/fides/pull/5085)
- Use the `user_id` from a Segment Trait instead of an `email` when deleting a user in Segment [#5004](https://github.com/ethyca/fides/pull/5004)
- Moves some endpoints for property-specific messaging from OSS -> plus [#5069](https://github.com/ethyca/fides/pull/5069)

### Developer Experience
Expand Down
7 changes: 5 additions & 2 deletions data/saas/config/segment_config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ saas_config:
type: segment
description: A sample schema representing the Segment connector for Fides
user_guide: https://docs.ethyca.com/user-guides/integrations/saas-integrations/segment
version: 0.0.5
version: 0.0.6

connector_params:
- name: domain
Expand Down Expand Up @@ -166,7 +166,10 @@ saas_config:
- name: workspace_name
connector_param: workspace
- name: user_id
identity: email
references:
- dataset: <instance_fides_key>
field: traits.user_id
Copy link
Contributor Author

@SteveDMurphy SteveDMurphy Jun 20, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I chose to use the traits, but it could also be that we use external_ids however it will end up generating extra requests so decided against it for the time being

direction: from
body: |
{
"regulation_type": "Suppress_With_Delete",
Expand Down
42 changes: 27 additions & 15 deletions data/saas/dataset/segment_dataset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,6 @@ dataset:
fields:
- name: segment_id
data_categories: [user.unique_id]
fidesops_meta:
primary_key: True
SteveDMurphy marked this conversation as resolved.
Show resolved Hide resolved
- name: track_events
fields:
- name: external_ids
Expand All @@ -25,7 +23,7 @@ dataset:
fields:
- name: name
data_categories: [user.name]
fidesops_meta:
fides_meta:
data_type: string
- name: version
data_categories: [system.operations]
Expand Down Expand Up @@ -57,19 +55,19 @@ dataset:
fields:
- name: city
data_categories: [user.contact.address.city]
fidesops_meta:
fides_meta:
data_type: string
- name: country
data_categories: [user.contact.address.country]
fidesops_meta:
fides_meta:
data_type: string
- name: postalCode
data_categories: [user.contact.address.postal_code]
fidesops_meta:
fides_meta:
data_type: string
- name: state
data_categories: [user.contact.address.state]
fidesops_meta:
fides_meta:
data_type: string
- name: age
data_categories: [user.demographic.age_range]
Expand All @@ -81,41 +79,55 @@ dataset:
data_categories: [user]
- name: email
data_categories: [user.contact.email]
fidesops_meta:
fides_meta:
data_type: string
- name: firstName
data_categories: [user.name]
fidesops_meta:
fides_meta:
data_type: string
- name: first_name
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

additional fields found in testing (these may be configurable by client?)

data_categories: [user.name]
fides_meta:
data_type: string
- name: gender
data_categories: [user.demographic.gender]
fidesops_meta:
fides_meta:
data_type: string
- name: id
data_categories: [user.unique_id]
fides_meta:
primary_key: true
SteveDMurphy marked this conversation as resolved.
Show resolved Hide resolved
- name: industry
data_categories: [system.operations]
- name: lastName
- name: last_name
data_categories: [user.name]
fides_meta:
data_type: string
- name: name
data_categories: [user.name]
fidesops_meta:
fides_meta:
data_type: string
- name: phone
data_categories: [user.contact.phone_number]
fidesops_meta:
fides_meta:
data_type: string
- name: subscriptionStatus
- name: title
data_categories: [user.name]
fidesops_meta:
fides_meta:
data_type: string
- name: username
data_categories: [user.name]
fidesops_meta:
fides_meta:
data_type: string
- name: website
data_categories: [user]
fidesops_meta:
fides_meta:
data_type: string
- name: user_id
data_categories: [user.unique_id]
fides_meta:
data_type: string
- name: external_ids
fields:
Expand Down
Loading