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 Delegated Admin Attribute defines an LDAP attribute which can be accessed by a client of the Delegated Admin API.
↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage
The following components have a direct aggregation relation from Delegated Admin Attributes:
The following components have a direct composition relation to Delegated Admin Attributes:
The properties supported by this managed object are as follows:
| Basic Properties: | Advanced Properties: |
|---|---|
| ↓ description | None |
| ↓ attribute-type | |
| ↓ display-name | |
| ↓ mutability | |
| ↓ multi-valued | |
| ↓ include-in-summary | |
| ↓ attribute-category | |
| ↓ display-order-index | |
| ↓ reference-resource-type | |
| ↓ attribute-presentation | |
| ↓ date-time-format |
| Description | A description for this Delegated Admin Attribute |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the name or OID of the LDAP attribute type. |
| 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 | A human readable display name for this Delegated Admin Attribute. |
| Default Value | None |
| Allowed Values | A string |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the circumstances under which the values of the attribute can be written. |
| Default Value | read-write |
| Allowed Values | read-only - The attribute cannot be modified. read-write - The attribute may be updated and read at any time. |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this Delegated Admin Attribute may have multiple values. If the LDAP attribute type is single-valued in the LDAP schema then this property may not be set to indicate that this Delegated Admin Attribute is multi-valued. If the LDAP attribute type is multi-valued in the LDAP schema then this property may be set to indicate that this Delegated Admin Attribute is multi-valued, or may be set to indicate that this Delegated Admin Attribute should be treated as if there is only ever a single value. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates whether this Delegated Admin Attribute is to be included in the summary display for a resource. If no attributes are configured to be included in the summary then the default behavior is for all search attributes and all required attributes to appear in the summary. However, if any attributes are configured to be included in the summary then only those attributes appear in the summary. |
| Default Value | false |
| Allowed Values | true false |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies which attribute category this attribute belongs to. |
| Default Value | This attribute is not assigned to any attribute category and will be displayed after all attributes which do have an attribute category. |
| Allowed Values | The DN of any Delegated Admin Attribute Category. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | This property determines a display order for attributes within a given attribute category. Attributes are ordered within their category based on this index from least to greatest. Values of this property are not required to be contiguous. If there are multiple attributes in the same attribute category with the same index, those attributes are displayed in an arbitrary order within their category. |
| Default Value | 0 |
| Allowed Values | An integer value. Lower limit is 0. Upper limit is 2147483647 . |
| Multi-Valued | No |
| Required | Yes |
| Admin Action Required | None. Modification requires no further action |
| Description | For LDAP attributes with DN syntax, specifies what kind of resource is referenced. |
| Default Value | None |
| Allowed Values | The DN of any REST Resource Type. The referenced resource type must be enabled. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Indicates how the attribute is presented to the user of the app. |
| Default Value | An attribute with JSON object syntax receives custom presentation and an attribute with any other syntax receives a default presentation for its syntax. |
| Allowed Values | default - The attribute receives a default presentation for its syntax. custom - The attribute receives custom presentation. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
| Description | Specifies the format string that is used to present a date and/or time value to the user of the app. This property only applies to LDAP attribute types whose LDAP syntax is GeneralizedTime and is ignored if the attribute type has any other syntax. This format string conforms to the syntax described in the API documentation for the java.text.SimpleDateFormat class. Example values for usage include:
|
| Default Value | yyyy-MM-dd |
| Allowed Values | Any valid format string that can be used for date formatting and date input parsing using the java.text.SimpleDateFormat class. |
| Multi-Valued | No |
| Required | No |
| Admin Action Required | None. Modification requires no further action |
To list the configured Delegated Admin Attributes:
dsconfig list-delegated-admin-attributes
[--property {propertyName}] ...
To view the configuration for an existing Delegated Admin Attribute:
dsconfig get-delegated-admin-attribute-prop
--attribute-type {name}
--type-name {name}
[--tab-delimited]
[--script-friendly]
[--property {propertyName}] ...
To update the configuration for an existing Delegated Admin Attribute:
dsconfig set-delegated-admin-attribute-prop
--attribute-type {name}
--type-name {name}
(--set|--add|--remove) {propertyName}:{propertyValue}
[(--set|--add|--remove) {propertyName}:{propertyValue}] ...
To create a new Delegated Admin Attribute:
dsconfig create-delegated-admin-attribute
--attribute-type {name}
--type-name {name}
--set display-name:{propertyValue}
[--set {propertyName}:{propertyValue}] ...
To delete an existing Delegated Admin Attribute:
dsconfig delete-delegated-admin-attribute
--attribute-type {name}
--type-name {name}