This repository has been archived by the owner on Nov 30, 2022. It is now read-only.
Explain Privacy Request Execution [#1397] #1396
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
pattisdr
changed the title
|
@conceptualshark, @ethyca/docs-authors Sean asked me to take a stab at a first draft of how Privacy Request Execution works, for the guides, separate from how we configure Fidesops. |
conceptualshark
approved these changes
Sep 28, 2022
pattisdr
commented
Sep 28, 2022
| 6. Email Erasure Requests Step | ||
| 7. Policy Post-Execution Webhooks Step | ||
| 8. Follow-up Email Notification Step | ||
| Manual webhooks allow data pertaining to be manually uploaded by a fidesops admin. If manual webhooks are enabled, request execution will exit with a status of `requires_input` until a submission has been received for each manual webhook configured. The privacy request can then be resumed, and request execution will continue from this step. See [Manual Webhooks](manual_webhooks.md) for more information on configuration options and resuming a `requires_input` request. |
There was a problem hiding this comment.
Missed words, maybe "Manual webhooks allow data pertaining to a subject"
| Fidesops admins should separately upload data for each webhook, or a blank response if no data is found. The privacy | ||
| request can then be resumed, and request execution will continue from this step. See [Manual Webhooks](manual_webhooks.md) for more information | ||
| on configuring manual webhooks and resuming a `requires_input` request. | ||
| Fidesops sends a request to each pre-execution webhook with a [policy webhooks request format](policy_webhooks.md#policy-webhook-request-format), which your endpoints should be prepared to unpack. If you need more time to carry out an action, your webhook can instruct Fidesops to `halt`, which will cause execution to exit with a status of `paused`. Request execution can be continued when ready using a token supplied in the original request. | ||
|
|
There was a problem hiding this comment.
lowercase "Fidesops to halt"?
| reach a Collection, it will exit early with a status of `error`. To remedy, you will have to | ||
| how your Collections are related to each other in your Datasets and resubmit the privacy request. | ||
| Fidesops builds a Directed Acyclic Graph, or DAG, where each location or node corresponds to a Collection in one of your Datasets. The graph helps determine the order in which nodes will be visited. Fidesops begins with any Collections that can be queried using the supplied identity data, and then points those Collections toward dependent Collections, etc. If fidesops can't determine out how to reach a Collection, it will exit early with a status of `error`. To remedy an errored access request, you update how your Collections are related to each other in your Datasets, and resubmit the privacy request. | ||
|
|
There was a problem hiding this comment.
Just checking, is determine out how to reach intentional or would it be determine how to reach
|
🙏 Thank you for the proofread! Should be all set. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Purpose
We have guides talking about how to configure Fidesops but we're missing a high-level explanation of how Privacy Request Execution works.
Changes
Fidesops Privacy Request Executionpage to the docsChecklist
CHANGELOG.mdfileCHANGELOG.mdfile is being appended toUnreleasedsection in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.Run Unsafe PR Checkslabel has been applied, and checks have passed, if this PR touches any external servicesTicket
Fixes #1397