Admin UI guide

Consent Management v2 provides a web-based interface where you manage consent documents, versions, and localizations, and query consent events. It is integrated into the OneWelcome Identity Platform console.

Document management

A consent document (for example, Privacy Policy) is the anchor for all versions and consent records.

The document details include the document type, whether it is mandatory, and the default language. The document type classifies the document. The following standard types are available:

• PRIVACY_POLICY: Privacy policy document
• TERMS_OF_SERVICE: Terms of service or terms and conditions
• COOKIE_POLICY : Cookie usage policy
• MARKETING_PERMISSION: Consent to receive marketing communications
• CUSTOM: A custom type that you define for other document types

Document list

When you open the Consent Management console, a paginated table lists all the documents for your tenant.

The table includes the following columns:

Column	Description
Name	The document name (for example, Privacy Policy)
Type	The document type (for example, PRIVACY_POLICY, TERMS_OF_SERVICE)
Mandatory	Indicates whether user consent is required to access the service
Last updated	The date and time when the document was last modified

You can sort the table by any column and use the pagination controls to navigate between pages.

Create a document

1. In the document list, select Create document.

2. Enter the following information:

   • Name: The document name must be unique (1–100 characters).

   • Document type: Select from the list: Privacy Policy, Terms of Service, Cookie Policy, Marketing Permission, or Custom.

   • Custom type key: When you select the Custom document type, enter a key in UPPER_SNAKE_CASE format (for example, EMPLOYEE_HANDBOOK).

   • Mandatory: Toggle on if users must consent to access the service.

   • Default language: Select the default locale from the tenant's configured languages.

   • Description: (Optional) The description can include up to 1,000 characters.

3. Select Save.

The new document appears in the document list with no versions.

View document details

To open the document details page, select a document name in the list.

The detail page shows:

• The document definition properties (name, type, mandatory flag, default language).

• A table of all versions with their status, version number, version name, and lifecycle dates.

Edit a document

You can modify the Name, Description, Default language, and Mandatory settings. The Document type and Custom type key are not editable after you create and save a document.

Changing the default language is allowed only if all ACTIVE and SCHEDULED versions already have a localization in the new language.

On the document details page, select Edit.

Delete a document definition

Deleting is allowed only if the document has no versions or if all versions have the DRAFT status.

On the document details page, select Delete.

Version management

On the document details page, the versions table lists all versions of the document.

For each version, the table includes:

Column	Description
Version number	The sequential version number (blank for DRAFT versions that are not yet scheduled)
Version name	Human-readable label
Status	The computed lifecycle status: DRAFT, SCHEDULED, ACTIVE, SUNSET, or ARCHIVED
Effective date	When the version became or will become active
Sunset date	When the version stops accepting new consents (if set)
Archive date	When the version is archived (if set)
Last updated	Date of the last modification

DRAFT versions with no version number appear at the top of the table.

Create a version

1. On the document details page, select Create version.

2. Enter a Version name (unique within the document).

3. Optionally add localizations in the creation form (see Add a localization).

4. Select Save.

The version is created in DRAFT status with no version number.

Schedule a version for activation

1. Open the version detail page.

2. In the Lifecycle management section, enter an Effective date.

3. Select Save (or Schedule).

The version transitions to the SCHEDULED status and the system assigns a version number. On the effective date, the status automatically changes to ACTIVE.

Configure a grace period

To allow existing users a transition period when a new version replaces an existing one:

1. On the previous version (the version being replaced), open the lifecycle management section.

2. Set the Sunset date to the date the previous version should stop accepting new consents (typically equal to the new version's effective date).

3. Set the Archive date to the end of the grace period — the date after which users who have not consented to the new version will be blocked.

4. Save the changes.

The previous version enters SUNSET status on the sunset date, and ARCHIVED status on the archive date.

Clone a version

To create a new version based on an existing version:

1. In the version actions menu, select Clone.

2. Optionally provide a new version name (the default is {original name} (Copy)).

3. Select Save.

The clone is created as a DRAFT with all localizations copied and lifecycle dates cleared.

Delete a version

Only DRAFT versions can be deleted. On the version details page or in the version actions menu, select Delete. SCHEDULED versions must be unscheduled first.

Localization management

Localization list

On the version detail page, a table lists all localizations for the version. Each row includes:

Column	Description
Language	The locale code (for example, en_US)
Title	The localized document title
Lineage	Whether the localization is NEW_CONTENT or DERIVED
Content URL	The external URL to the document content

Add a localization

You can add localizations when creating a version, or at any time while the version is in the DRAFT, SCHEDULED, or ACTIVE status.

1. On the version detail page, select Add localization.

2. Select the Language from the list.

   The list includes only supported locales. A version can have at most one localization per language.

3. Enter the Title for the document in this language (1–100 characters).

4. Select the Lineage:

   • New content: The document text is new or has changed. Enter the Content URL pointing to the externally hosted document.

   • Derived: The document text is legally equivalent to another localization. Select the Source localization from the available list of localizations in ACTIVE, SUNSET, or ARCHIVED versions. The content URL is inherited automatically.

5. Select Save.

Edit a localization

On the localization details page or using the edit action in the localization list, you can update the Title and Content URL. The Language and Lineage fields cannot be changed after creation.

Localizations on SUNSET or ARCHIVED versions are read-only and cannot be edited.

Delete a localization

Select the delete action for the localization. Deletion is blocked if:

• It is the last remaining localization for the version.
• It is the localization for the document's default language and no other localization covers the same language.

Consent events

The consent ledger view provides a queryable, read-only list of all consent events for your tenant.

Search and filter

The ledger view supports the following filters:

Filter	Description
User ID	Filter records for a specific user.
Document	Filter by document definition name or type.
Consent status	Filter by GRANTED.
Date range	Filter by the date the consent was recorded (start and end date).
Language	Filter by locale code.
Mandatory	Show only mandatory or only optional document consents.
Search	Free-text search across document name, version name, and title

You can combine filters. Results are paginated with 50 records per page, by default.

Ledger table columns

The ledger table displays the following information per record:

Column	Description
User ID	The user who performed the consent action
Document	The document name
Version	The version number and name
Language	The locale of the consented localization
Status	GRANTED
Date	The timestamp of the consent action
Title	The document title at the time of consent

Export event records

Select Export to download the current filtered result set as a CSV file. The export includes all fields available in the ledger record, including the denormalized document metadata captured at consent time.