Directory Server Documentation Index
Configuration Reference Home

Consent Definition

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 represents a type of consent to share data.

Each Consent Definition represents an individual's consent to share particular data (the "what") for a particular purpose (the "why"). Consent Definitions always should have one or more child Consent Definition Localizations, which contain the localized text that is presented to an individual when collecting consent.

↓Relations from This Component
↓Properties
↓dsconfig Usage

Relations from This Component

The following components have a direct composition relation from Consent Definitions:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ unique-id  None
↓ display-name
↓ parameter
↓ description

Basic Properties

unique-id (Read-Only)

Description
A version-independent unique identifier for this Consent Definition. The name must be unique among all Consent Definitions in the server. The ID may not be altered after the Consent Definition is created.
Default Value
None
Allowed Values
An ID consisting only of ASCII letters, digits, '_' and '-' characters.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

display-name

Description
A human-readable display name for this Consent Definition.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

parameter

Description
Optional parameters for this Consent Definition. A Consent Service client may use a Consent Definition's consent parameter list to capture specific data from an individual when requesting consent.
Default Value
None
Allowed Values
A string
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

description

Description
A description for this Consent Definition
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Consent Definitions:

dsconfig list-consent-definitions
     [--property {propertyName}] ...

To view the configuration for an existing Consent Definition:

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

To update the configuration for an existing Consent Definition:

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

To create a new Consent Definition:

dsconfig create-consent-definition
     --definition-name {name}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Consent Definition:

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