Domain Management lets you create and manage custom and managed domains across Didomi products. It ensures that domains are correctly set up before being used - for example, to load a Preference Center site or serve the CMP SDK. The system checks domain configuration, DNS propagation, and usage rules before allowing a domain to be used by Didomi products.
Domain types and usage
There are two types of domain usage in Didomi:
1. Load the Didomi SDK
- Loads the Didomi SDK.
- Can be used for Consent Notices, Preference and Privacy request widgets.
- Not linked to a specific widget.
- One domain can load several products at once.
- The domain is included in the snippet code used to load and display the widget.
2. Serve a hosted page
- Loads a webpage hosted by Didomi, such as the Preference Center or a DSAR form.
- Can be used for Preference and Privacy request widgets.
- Linked to one widget only.
- Must be detached from the widget before it can be deleted.
- Can only be used by one widget at a time.
- The domain is the URL used by end-user to access the widget.
Access the Domain List
Access to the Domain list requires a specific role. Make sure you have the necessary permissions before proceeding.
To access the Domain list:
- Click on My Organization
- Click on Organization Settings
- Go to the Domains tab
You can find the following information in the Domain list:
Error | Description |
---|---|
Status | The current status of the domain (e.g., Ready, Draft, Failed, Verifying, Deleting). |
Name | Full domain name (e.g., cmp.domain.com). |
Usage | Indicates how the domain is used (e.g., SDK, Webpage). |
Type | DNS record type, always NS (Name Server). |
Value | NS record values to enter in your DNS provider. |
Bot indexing | Whether bots are allowed to crawl the domain. (Allowed or Blocked) |
Actions | Icons for copy NS values, edit the domain, or delete the domain (varies depending on domain status). |
Create a new domain
To create a new domain, click the Add domain button in the Domain list.
- Register a domain name
- Select the usage of the domain (Load the SDK or Load a webpage)
- Allow or block bots from indexing your custom domain
- Create the NS record
- You must create the NS records with your DNS provider, and they must be fully propagated before proceeding.
- If the DNS is ready, continue to the next step and submit the domain.
- If the DNS is not ready, save the domain as a draft and return later to complete the setup.
- You must create the NS records with your DNS provider, and they must be fully propagated before proceeding.
- Submit the domain for provisioning.
Edit a draft domain
To edit a domain in draft status, click the Pencil icon next to the domain in the list.
Once your DNS is ready, update the draft domain to complete the setup so we can proceed with provisioning.
Retry a failed domain
If domain creation fails, it may be due to a processing error in the Didomi system or DNS settings that haven’t propagated yet.
To retry, click the Circular arrows icon next to the failed domain in the list.
Delete a domain
You can delete a domain by clicking on the Trash button in the Domain list.
- For SDK domains, the domain can be deleted. Make sure to decommission the widget before proceeding.
- For Webpage domains, the domain must be unattached from the widget before it can be deleted.
Use a domain with a product
You can use the domain to load the CMP SDK for consent notices, the PMP SDK for preferences or privacy widgets, and also to serve the Preference Center as a standalone webpage.
Summary of domain capabilities
Feature | Load the SDK (usage cmp in the API) |
Load a hosted page (usage preference-center in the API) |
---|---|---|
Loads Didomi SDK (CMP, PMP, DSAR) | ✅ | ❌ |
Loads Preference Center / DSAR UI | ❌ | ✅ |
NS record validation required | ✅ | ✅ |
Can be reused across products | ✅ | ❌ |
Tied to a widget | ❌ | ✅ |
Allow bots to crawl the domain | ✅ | ✅ |
Must be detached from the widget before deletion | ❌ | ✅ |