Skip to content

Manage Consent in the Privacy Center

The Fides Privacy Center provides configurable consent settings for regulatory compliance, allowing users to access and edit their data use preferences.

To learn more about configuring your Privacy Center for DSR enforcement, see the DSR automation guide.

Consent Options

Configuration

The Fides Privacy Center's text and actions are managed by a config.json file, which should be located in your project’s /clients/app/config directory. More information on configuration options can be found in the Privacy Center guide.

{
  "title": "Take control of your data",
  "description": "When you use our services, you’re trusting us with your information. We understand this is a big responsibility and work hard to protect your information and put you in control.",
  "server_url_development": "http://localhost:8080/api/v1",
  "server_url_production": "https://<$YOUR_SERVER_URL>/api/v1",
  "logo_path": "/logo.svg",
  "actions": [
    {
      "policy_key": "default_access_policy",
      "icon_path": "/download.svg",
      "title": "Access your data",
      "description": "We will email you a report of the data related to your account.",
      "identity_inputs": {
        "name": "optional",
        "email": "required",
        "phone": "optional"
      }
    },
    {
      "policy_key": "default_erasure_policy",
      "icon_path": "/delete.svg",
      "title": "Erase your data",
      "description": "We will delete all of your account data. This action cannot be undone.",
      "identity_inputs": {
        "name": "optional",
        "email": "required",
        "phone": "optional"
      }
    }
  ],
  "includeConsent": true,
  "consent": {
    "cookieName": "fides_consent",
    "consentOptions": [
      {
        "fidesDataUseKey": "advertising",
        "name": "Advertising / Data Sharing",
        "description": "We may use some of your personal information for advertising performance analysis and audience modeling for ongoing advertising which may be interpreted as 'Data Sharing' under some regulations.",
        "url": "https://example.com/privacy#advertising",
        "default": true,
        "highlight": false,
        "cookieKeys": ["data_sales"]
      },
      {
        "fidesDataUseKey": "improve",
        "name": "Product Analytics",
        "description": "We may use some of your personal information to collect analytics about how you use our products & services, in order to improve our service.",
        "url": "https://example.com/privacy#data-sales",
        "default": true,
        "highlight": false,
        "cookieKeys": ["data_sales"]
      },
      {
        "name": "Analytics",
        "fidesDataUseKey": "third_party_sharing",
        "description": "...",
        "url": "https://example.com/privacy#analytics",
        "cookieKeys": ["data_sharing"]
      },
      {
        "name": "Personalize",
        "fidesDataUseKey": "personalize",
        "default": true,
        "url": "https://example.com/privacy#personalize",
        "description": "...",
        "cookieKeys": ["functional"]
      },
      {
        "name": "Essential",
        "fidesDataUseKey": "provide.service",
        "default": true,
        "url": "https://example.com/privacy#essential",
        "highlight": true,
        "description": "...",
        "cookieKeys": ["essential"]
      }
    ]
  }
}
KeyDescription
title and descriptionText fields to override the default text of either the main portal, or the associated action.
server_url_developmentThe Fides server URL to use for development deployments.
server_url_productionThe Fides server URL to use for production deployments.
logo_pathThe relative path to a brand or site logo to replace the default.
actionsA list of action objects, each of which represent a new tile available in the portal, and are associated to a single Fides policy.
policy_keyThe key of the policy to use for this action.
icon_pathThe relative path of an icon to replace the defaults.
identity_inputsThe list of personally identifiable information required by an action.

Consent

To provide compliance with local and internal regulations, you may define a series of data uses in your Privacy Center configuration. More information on including data uses for third-party services can be found in the Google Tag Manager guide.

KeyDescription
includeConsentWhere or not the consent options are enabled.
cookieNameThe name of the stored cookie.
title and descriptionText fields to override the default text of the associated consent option.
urlThe URL where a user can find additional information about this data use.
defaultIf this consent preference is enabled (true) or disabled (false) by default.
highlightWhether or not this consent preference is highlighted.
cookieKeysThe data use represented within your stored cookie.

Actions

To learn more about configuring your Privacy Center for DSR enforcement, see the DSR automation guide.

Run the Privacy Center

The Privacy Center is provided in a separate Docker image. To begin, run the following command:

docker pull ethyca/fides-privacy-center

The Privacy Center can be deployed independently, or alongside any other hosted components.

Once configured, the Privacy Center can be started with the following command:

docker run ethyca/fides-privacy-center