You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: src/privacy/hipaa-eligible-segment.md
+22-9Lines changed: 22 additions & 9 deletions
Original file line number
Diff line number
Diff line change
@@ -35,12 +35,12 @@ These logs can be provided upon request. For specific requests, please reach out
35
35
36
36
## Data encryption
37
37
38
-
Segment encrypts the data in fields [marked as yellow in the Privacy Portal](/docs/privacy/portal/#default-pii-matchers) before sending it to event stream, cloud mode destinations, further supporting HIPAA compliance in your destinations.
38
+
Segment encrypts the data in select fields [marked as yellow in the Privacy Portal](/docs/privacy/portal/#default-pii-matchers) before sending them to event stream, cloud mode destinations, further supporting HIPAA compliance in your destinations.
39
39
40
40
> info "Data encryption is currently in public beta"
41
-
> Data encryption supports event-stream, cloud-mode destinations. Engage destinations are not supported. Only data fields in `context`, `traits`, and `property` objects can be encrypted.
41
+
> Data encryption only supports event-stream, cloud-mode destinations. Only data fields in `context`, `traits`, and `property` objects can be encrypted.
42
42
>
43
-
> After Segment encrypts the data, it is converted into a `string`. Any downstream validation that looks for `integer` data types will fail for encrypted values.
43
+
> After Segment encrypts the data, the encrypted data value will always be a `string`. Any downstream validation that looks for `integer` data types will fail for encrypted values.
44
44
45
45
### Configure data encryption for a new destination
46
46
@@ -50,40 +50,53 @@ To configure data encryption while setting up a new destination:
50
50
3. On the destination's overview page, click **Add destination**.
51
51
4. On the Select data source page, select the source you want to connect to your destination and click **Next**.
52
52
5. On the Setup page, give your destination a name, fill in any optional settings, and select the **Have Segment encrypt sensitive data** checkbox.
53
-
6. Open the **Fields** dropdown, select one or more fields you'd like to encrypt and click the **Generate Encryption Keys** button. <br> *If you don't see all of the fields that you want to encrypt, [change the classification of your missing data fields](/docs/privacy/portal/#change-a-recommended-classification) in the Privacy Portal*.<br>
53
+
6. Open the **Fields** dropdown, select one or more fields you'd like to encrypt and click the **Generate Encryption Keys** button. <br> *If you don't see all of the fields that you want to encrypt, [change the classification of your missing data fields](/docs/privacy/portal/#change-a-recommended-classification)to Yellow in the Privacy Portal*.<br>
54
54
7. Securely store your private key - **once you finish setting up the destination, this key cannot be retrieved**.
55
55
8. Click **Create destination**.
56
56
57
57
> error "Private Key is not recoverable"
58
-
> Segment does not save the private key created during the data encryption setup flow, and cannot retrieve the key after you finish setting up your destination. You can generate a new key without decrypting your data using the instructions in the [Configure new key pairs](#configure-new-key-pairs) section. Any data encrypted prior to generating a new key pair cannot be decrypted with the new key.
58
+
> Segment does not save the private key created during the data encryption setup flow, and cannot retrieve the key after you finish setting up your destination. You can generate a new key using the instructions in the [Configure new key pairs](#configure-new-key-pairs) section. Any data encrypted prior to generating a new key pair cannot be decrypted with the new key.
59
59
60
60
### Configure data encryption for an existing destination
61
61
62
62
To configure data encryption for an existing destination:
63
63
1. Open the [My destinations page](https://app.segment.com/goto-my-workspace/destinations){:target="_blank”} in the Segment app.
64
64
2. Select a destination, and click the **Data Encryption** tab.
65
65
3. On the Data Encryption page, select the **Have Segment encrypt sensitive data** checkbox.
66
-
4. Open the **Fields** dropdown, select one or more fields you'd like to encrypt and click the **Generate Encryption Keys** button. <br> *If you don't see all of the fields that you want to encrypt, [change the classification of your missing data fields](/docs/privacy/portal/#change-a-recommended-classification) in the Privacy Portal*.<br>
66
+
4. Open the **Fields** dropdown, select one or more fields you'd like to encrypt and click the **Generate Encryption Keys** button. <br> *If you don't see all of the fields that you want to encrypt, [change the classification of your missing data fields](/docs/privacy/portal/#change-a-recommended-classification)to Yellow in the Privacy Portal*.<br>
67
67
5. Securely store your private key - **once you finish configuring data encryption, this key cannot be retrieved**.
68
68
6. Click **Save**.
69
69
70
70
> error "Private Key is not recoverable"
71
-
> Segment does not save the private key created during the data encryption setup, and cannot retrieve the key after you add data encryption to your destination. Segment cannot decrypt data if this key is lost. You can generate a new key any time using the instructions in the [Configure new key pairs](#configure-new-key-pairs) section. Any data encrypted prior to generating a new key pair cannot be decrypted with the new key.
71
+
> Segment does not save the private key created during the data encryption setup flow, and cannot retrieve the key after you finish setting up your destination. You can generate a new key using the instructions in the [Configure new key pairs](#configure-new-key-pairs) section. Any data encrypted prior to generating a new key pair cannot be decrypted with the new key.
72
72
73
73
### Configure new key pairs
74
74
75
75
If you lose access to your private key, you can generate a new key pair in your destination's Data Encryption tab. Any data previously encrypted using the previous key pair is unaffected, but cannot be decrypted using the new key.
76
76
77
77
To generate a new key pair:
78
78
1. Open the [My destinations page](https://app.segment.com/goto-my-workspace/destinations){:target="_blank”} in the Segment app.
79
-
2. Select the destination you'd like to create new keys for and click **Settings**.
79
+
2. Select the destination you'd like to create new keys for and click **Data Encryption**.
80
80
3. Click **Regenerate Encryption Keys**.
81
81
4. Securely store your private key - **once you close the dialog box, this key cannot be retrieved**.
82
82
5. Click **Save Changes** to update the key pair.
83
83
84
+
### Edit encrypted fields
85
+
86
+
After enabling encryption for a destination, you can add or remove encrypted data fields in your destination's Data Encryption tab. All changes made to fields are forward-looking. You may experience some latency between making the changes and having the changes take effect.
87
+
88
+
To make changes to your selected fields:
89
+
1. Open the [My destinations page](https://app.segment.com/goto-my-workspace/destinations){:target="_blank”} in the Segment app.
90
+
2. Select the destination you'd like to edit your selected fields for and click **Data Encryption**.
91
+
3. Add or remove fields.
92
+
- To add fields, click into the **Fields** box to open the dropdown and select one or more fields you'd like to add.
93
+
- To remove fields, click the x icon next to the name of the field you'd like to remove.
94
+
4. Click **Save Changes**.
95
+
96
+
84
97
### Remove encryption
85
98
86
-
Disabling the data encryption setting removes encryption on all data that comes into a destination after the setting was disabled.
99
+
Disabling the data encryption setting removes encryption on all previously configured data.
87
100
88
101
To remove encryption from incoming data:
89
102
1. Open the [My destinations page](https://app.segment.com/goto-my-workspace/destinations){:target="_blank”} in the Segment app.
0 commit comments