Directory Server Documentation Index
Configuration Reference Home

JSON Object Attribute Syntax

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.

The JSON Object Attribute Syntax defines a syntax for attribute values that represent JSON objects. The OID for this syntax is 1.3.6.1.4.1.30221.2.3.4. The default equality matching rule is the jsonObjectExactMatch rule (OID 1.3.6.1.4.1.30221.2.4.12), but advanced matching can be performed using the jsonObjectFilterExtensibleMatch matching rule (OID 1.3.6.1.4.1.30221.2.4.13). See the Javadoc documentation for the com.unboundid.ldap.sdk.unboundidds.jsonfilter.JSONObjectFilter class (available in the Commercial Edition of the UnboundID LDAP SDK for Java) and its subclasses for detailed information about JSON object filters.

Note that this attribute syntax will always attempt to compact JSON objects when storing them in the backend. This can save a substantial amount of space, although JSON objects retrieved from the server may have a different string representation than they originally had when they were stored, particularly with regard to insignificant whitespace characters.

Parent Component
Properties
dsconfig Usage

Parent Component

The JSON Object Attribute Syntax component inherits from the Attribute Syntax

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ enabled ↓ require-binary-transfer

Basic Properties

enabled

Description
Indicates whether the Attribute Syntax is enabled.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


Advanced Properties

require-binary-transfer (Advanced Property)

Description
Indicates whether values of this attribute are required to have a "binary" transfer option as described in RFC 4522. Attributes with this syntax will generally be referenced with names including ";binary" (e.g., "userCertificate;binary").
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
The Directory Server must be restarted for changes to this setting to take effect. Changes to this property will take effect immediately for new attribute type definitions created after the change, but the change will not take effect for existing attributes with this syntax until the server is restarted.


dsconfig Usage

To list the configured Attribute Syntaxes:

dsconfig list-attribute-syntaxes
     [--property {propertyName}] ...

To view the configuration for an existing Attribute Syntax:

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

To update the configuration for an existing Attribute Syntax:

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