generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 2
feat: add Osano consent mapping component #102
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
Open
KokaKiwi
wants to merge
2
commits into
main
Choose a base branch
from
feat/osano
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
121 changes: 121 additions & 0 deletions
121
components/consent-management/osano-consent-mapping.mdx
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,121 @@ | ||
--- | ||
title: Osano Consent Mapping | ||
description: Integrate user consent managed by Osano with your Edgee components. | ||
--- | ||
|
||
import EdgeeSdk from '/snippets/edgee-sdk.mdx'; | ||
|
||
<EdgeeSdk /> | ||
|
||
[Osano](https://www.osano.com) is an intuitive data privacy platform that helps organizations manage privacy compliance across multiple regulations and jurisdictions, including cookie consent management for data privacy laws in over 50 countries. | ||
|
||
With this component, you no longer need to [specify your users' consent](/services/consent/overview) | ||
via the Edgee SDK or Edgee Data Layer: everything is done automatically. | ||
|
||
The consent status will be automatically set to `pending`, `granted`, or `denied` based on evaluating ALL Osano consent categories together. | ||
|
||
## Getting Started | ||
|
||
<Steps> | ||
<Step title="Navigate to Components"> | ||
Open the Edgee console and navigate to your project's Components section. | ||
</Step> | ||
|
||
<Step title="Add the Component"> | ||
Select "Add a component" and choose `edgee/osano-consent-mapping` from the list of available components. | ||
</Step> | ||
|
||
<Step title="Activate the Component"> | ||
Activate the component using the toggle on the top right of the component card. | ||
</Step> | ||
|
||
<Step title="Confirm Setup"> | ||
Confirm with "Add component" to complete the setup and begin automatic consent mapping. | ||
</Step> | ||
</Steps> | ||
|
||
## How It Works | ||
|
||
The Osano consent mapping component automatically reads the `osano_consentmanager` cookie that Osano sets on your website. This cookie contains encrypted consent information that includes various consent categories: | ||
|
||
- **ESSENTIAL**: Necessary functionality | ||
- **ANALYTICS**: Tracking and analytics consent | ||
- **MARKETING**: Marketing and advertising consent | ||
- **PERSONALIZATION**: Personalization and customization consent | ||
- **STORAGE**: Local storage consent | ||
|
||
<Note> | ||
The component evaluates **ALL** consent categories together to determine the overall consent status. This ensures comprehensive privacy compliance by respecting user choices across all consent types. | ||
</Note> | ||
|
||
### How the Component Works | ||
|
||
The component automatically: | ||
|
||
1. Reads the `osano_consentmanager` cookie from user requests | ||
2. Processes the cookie data to extract consent preferences | ||
3. Maps the consent categories to Edgee's consent model | ||
|
||
### Consent Mapping | ||
|
||
The component maps individual Osano category values as follows: | ||
|
||
| Osano Category Value | Interpreted As | | ||
|---------------------|----------------| | ||
| `ACCEPT` | `granted` | | ||
| `DENY` | `denied` | | ||
| Missing or invalid | `pending` | | ||
|
||
**Final Status Determination:** | ||
|
||
| Scenario | Final Edgee Consent | | ||
|----------|--------------------| | ||
| Any category denied | `denied` | | ||
| Any category pending (none denied) | `pending` | | ||
| All categories granted | `granted` | | ||
| No cookie or invalid data | `pending` | | ||
|
||
|
||
## Configuration | ||
|
||
No additional configuration is required for this component. The consent mapping works automatically once the component is activated in your Edgee project. | ||
|
||
<Tip> | ||
Make sure your Osano consent management platform is properly configured on your website before activating this component. The component relies on the presence of the `osano_consentmanager` cookie. | ||
</Tip> | ||
|
||
## Troubleshooting | ||
|
||
<AccordionGroup> | ||
|
||
<Accordion title="Consent mapping not working correctly"> | ||
**Possible causes:** | ||
- Domain name mismatch between Edgee configuration and Osano setup | ||
- Cookie encryption issues | ||
|
||
**Solution:** Ensure your Edgee project's frontend hostname matches the domain where Osano is deployed. | ||
</Accordion> | ||
|
||
<Accordion title="Consent showing as denied when some categories are granted"> | ||
**This is expected behavior.** The component uses a priority-based system where: | ||
- ANY denied category results in overall `denied` consent | ||
- This ensures comprehensive privacy compliance | ||
|
||
**To debug:** | ||
1. Check which specific categories are denied in your Osano dashboard | ||
2. Verify that users have granted consent for ALL required categories | ||
3. Remember that essential functionality might still work even with `denied` consent | ||
</Accordion> | ||
|
||
</AccordionGroup> | ||
|
||
## Privacy Compliance | ||
|
||
This component helps maintain privacy compliance by: | ||
- Automatically respecting user consent choices made through Osano | ||
- Ensuring consistent consent enforcement across all Edgee components | ||
- Supporting Osano's "$500,000 No Fines, No Penalties" guarantee through proper consent handling | ||
|
||
<Warning> | ||
Always ensure your Osano implementation complies with applicable privacy regulations in your jurisdiction. This component only maps existing consent data and does not handle the consent collection process itself. | ||
</Warning> |
This file contains hidden or 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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.