Directory Server Documentation Index
Configuration Reference Home

Consent Definition Localization

Note: this component stores cluster-wide configuration data and is mirrored across all servers in the topology within the the same cluster.

Note: changes to cluster-wide configuration objects are immediately and automatically mirrored across all servers within the same cluster, so offline changes are not supported.

A Consent Definition Localization stores the versioned, localized text of a Consent Definition.

Consent Definition Localizations are used by Consent Service clients to display consent prompts to end users. Every Consent Definition must have one or more associated Consent Definition Localizations, and each Consent Definition Localization must have a unique locale value per Consent Definition. Whenever the localized text of a Consent Definition Localization is updated, its version must also be updated.

↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct composition relation to Consent Definition Localizations:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ locale  None
↓ version
↓ title-text
↓ data-text
↓ purpose-text

Basic Properties

locale (Read-Only)

Description
The locale of this Consent Definition Localization. The locale value must be unique per Consent Definition and cannot be changed after the Consent Definition Localization is created. Locale values must conform to the BCP 47 language tag format supported by the JDK's Locale class. Example values are 'pt-BR' and 'fr-CA'.
Default Value
None
Allowed Values
A BCP 47 language tag consisting only of ASCII letters, digits, and '-' characters.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

version

Description
The version of this Consent Definition Localization, using the format MAJOR.MINOR. The version must be updated whenever the Consent Definition Localization is updated. Consent Service clients can use the version to determine if an individual's captured consent is current. Version values must use the format MAJOR.MINOR, where MAJOR and MINOR are integers.
Default Value
None
Allowed Values
A Consent Definition Localization value must use the format MAJOR.MINOR, where MAJOR and MINOR are integers. Example values are '1.1' and '2.13'.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

title-text

Description
Localized text that may be used to provide a title or summary for a consent request or a granted consent.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

data-text

Description
Localized text describing the data to be shared.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

purpose-text

Description
Localized text describing how the data is to be used.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Consent Definition Localizations:

dsconfig list-consent-definition-localizations
     [--property {propertyName}] ...

To view the configuration for an existing Consent Definition Localization:

dsconfig get-consent-definition-localization-prop
     --localization-name {name}
     --definition-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Consent Definition Localization:

dsconfig set-consent-definition-localization-prop
     --localization-name {name}
     --definition-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Consent Definition Localization:

dsconfig create-consent-definition-localization
     --localization-name {name}
     --definition-name {name}
     --set version:{propertyValue}
     --set data-text:{propertyValue}
     --set purpose-text:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Consent Definition Localization:

dsconfig delete-consent-definition-localization
     --localization-name {name}
     --definition-name {name}