Identity Data Store Documentation Index
Configuration Reference Home

Directory String Attribute Syntax

Note: this component has a complexity level of "expert", which means that objects of this type are not expected to be created or altered. Please contact UnboundID support for assistance if you believe that you have a need to create or modify this type of object.

The Directory String Attribute Syntax defines an attribute syntax for storing arbitrary string (and sometimes binary) data.

↓Parent Component
↓Properties
↓dsconfig Usage

Parent Component

The Directory String 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
↓ allow-zero-length-values

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 Identity Data Store 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.

allow-zero-length-values (Advanced Property)

Description
Indicates whether zero-length (that is, an empty string) values are allowed. This is technically not allowed by the revised LDAPv3 specification, but some environments may require it for backward compatibility with servers that do allow it.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action


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}] ...

To create a new Directory String Attribute Syntax:

dsconfig create-attribute-syntax
     --syntax-name {name}
     --type directory-string
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Attribute Syntax:

dsconfig delete-attribute-syntax
     --syntax-name {name}