Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.
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.
JSON Attribute Constraints may be used to specify a number of properties and constraints for JSON objects to be stored in attributes with a "JSON object" syntax. Each JSON Attribute Constraints definition will be associated with a set of json-field-constraints definitions that can collectively define a complete or partial schema for the JSON objects, and may also provide additional information about the way the server should treat those fields (e.g., whether any of the fields should be indexed for faster searching, or have their values tokenized for more compact storage).
↓Relations from This Component
↓Properties
↓dsconfig Usage
The following components have a direct composition relation from JSON Attribute Constraints:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ enabled | |
| ↓ attribute-type | |
| ↓ allow-unnamed-fields |
| Description | A description for this JSON Attribute Constraints |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this JSON Attribute Constraints is enabled. When creating a new JSON Attribute Constraints, it is recommended that it be disabled until all of the associated field constraints have also been defined. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | The name or OID of the LDAP attribute type whose values will be subject to the associated field constraints. This attribute type must be defined in the server schema, and it must have a "JSON object" syntax. |
| Default Value | None |
| Allowed Values | The name or OID of an attribute type defined in the server schema. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether JSON objects stored as values of attributes with the associated attribute-type will be permitted to include fields for which there is no subordinate json-field-constraints definition. If unnamed fields are allowed, then no constraints will be imposed on the values of those fields. However, if unnamed fields are not allowed, then the server will reject any attempt to store a JSON object with a field for which there is no corresponding json-fields-constraints definition. |
| Default Value | true |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured JSON Attribute Constraints:
dsconfig list-json-attribute-constraints
[--property {propertyName}] ...
To view the configuration for an existing JSON Attribute Constraints:
dsconfig get-json-attribute-constraints-prop
--attribute-type {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing JSON Attribute Constraints:
dsconfig set-json-attribute-constraints-prop
--attribute-type {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new JSON Attribute Constraints:
dsconfig create-json-attribute-constraints
--attribute-type {name}
[--set {propertyName}:{propertyValue}] ...
To delete an existing JSON Attribute Constraints:
dsconfig delete-json-attribute-constraints
--attribute-type {name}