Consent Docs
Open console

Administrator guide

Settings, properties, keys, access and data retention for project administrators, and running your own deployment for operators.

For project administrators and deployment operators

This guide is for the people who look after a project, and for those who run a deployment. The first four groups cover the console: project settings, access, properties, keys, webhooks and how long data is kept. Self-hosting covers installing, upgrading and operating your own deployment. Platform team covers the law the deployment follows and approving live keys.

Start with#

Project

  • Change project settingsOpen the project settings, change the privacy contact, deadlines and data handling for every property, and see each default.
  • Access and rolesWho can open a project in the console, the six project roles, what each may do, and how second-person approval works.
  • Read the audit logFind who changed or viewed what in the console and when, filter the log, and know what it records and what it does not.
  • Verify the audit logRecompute the seal of every audit log entry and its link to the one before, to show that no entry was changed, removed or inserted.
  • Download the audit logDownload the project's audit log for a range of days as CSV or JSON lines, and archive old entries.
  • Stream the audit logPull the audit log into your SIEM with a key, or collect it from the API's standard output on your own deployment.
  • Usage and limitsHow the monthly record count works, what happens when you pass your plan, and the rate limits on keys and addresses.
  • Set up the translation serviceChoose the service that drafts translations of your form and purpose wording, and add its key in project settings.
  • Significant Data FiduciaryMark the project as a Significant Data Fiduciary, keep the yearly assessments and audits, and download the report for the Data Protection Board.

Properties

  • Manage propertiesAdd a website or app as a property, change its name and origins, and delete one that was created by mistake.
  • Export and import a propertySave a property with its forms, rules and records to one file, and create a new property from that file somewhere else.

Keys and webhooks

  • Create a keyCreate the key that connects a site, app or server to your project, and copy the secrets that are shown only once.
  • Request to go liveAsk for a test key to become a live key, and know what changes once the request is approved or declined.
  • Manage keysRead the keys list, change what a secret key may do, rotate an identity secret and revoke a key you no longer use.
  • Manage webhook endpointsAdd an endpoint that receives consent events, keep its signing secret, and check deliveries, retries and automatic disabling.

Data lifecycle

  • Record retentionHow long consent records and other data are kept, when a record can be deleted, and what stays behind after deletion.
  • Erase people after inactivityTurn on erasure of a person's identifiers after a set time without activity, and make sure the person is told first.
  • Processor registerMark which partners on your purposes are Data Processors, with their contact and the days they have to stop and to erase.
  • Processor tasksFind processor tasks that are open or overdue, record what each processor reported with an evidence file, and check a file against a report.
  • Verify evidence anchorsKeep your own copy of each day's signed anchor, and check any day against the database as it is now.
  • Legal holdsPlace a legal hold so evidence is kept past its retention while a complaint, an inquiry or an appeal runs, then release it.
  • Close a projectExport a project's data, then schedule its deletion at the end of your contract, with a date you can cancel until.

Self-hosting

  • Deploy with Docker ComposeStart the API, the console, the documentation, PostgreSQL and Redis with Docker Compose, put them behind TLS and connect sign-in.
  • Serve the documentationPublish this documentation from your own deployment on its own hostname, and link the console to it.
  • Upgrade and roll backMove a self-hosted deployment to a newer build, check it, and return to the earlier build if something goes wrong.
  • Back up and restoreBack up the database and the secrets of a self-hosted deployment, restore them, and know what a restore loses or repeats.
  • Test a restoreRestore a backup into a throwaway database, and check its rows, evidence anchors and audit log chains against your recovery targets.
  • Monitor a deploymentCheck health, scrape the Prometheus metrics, and set the first alerts for a self-hosted deployment.
  • Replay failed webhooksSend failed webhook events again from the console once the receiving server is fixed and the endpoint is turned back on.
  • Rotate secretsRotate the evidence chain key, change the receipt signing key and other credentials, and know which secrets must never change.
  • Scheduled jobsEvery job the API runs on a schedule, when it runs, what it does and whether one replica or every replica does the work.

Platform team

  • Approve live keysReview a customer's request to go live and approve or decline it in the Platform area of the console, or with the platform key of your deployment.
  • Change a DPDP ruleRecord a new DPDP date, period, threshold, list or wording when the Government notifies one. One platform person drafts it and a second approves.
  • Write a DPDP ruleAdd a duty the product does not check yet, so it appears on every DPDP Act check it applies to and can hold back publishing a form.
  • Record a Gazette notificationAdd a notification the Government published, and the provisions in it word for word, so rules can rest on them and quote them.

↑↓ to move, Enter to open