Directory Proxy Server Documentation Index
Configuration Reference Home

LDAP Correlation Attribute Pair

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 LDAP Correlation Attribute Pair object defines an attribute pair that share a common value between a SCIM Resource Type and a Correlated LDAP Data View.

↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations to This Component

The following components have a direct composition relation to LDAP Correlation Attribute Pairs:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ primary-correlation-attribute  None
↓ secondary-correlation-attribute

Basic Properties

primary-correlation-attribute

Description
The Store Adapter attribute from the base SCIM Resource Type whose value will be used to match objects in the Correlated LDAP Data View.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

secondary-correlation-attribute

Description
The LDAP attribute from the Correlated LDAP Data View whose value will be matched. On a create request, if this attribute does not already have a value from the request, then the attribute is automatically created with a value equal to that of the primary correlation attribute.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured LDAP Correlation Attribute Pairs:

dsconfig list-ldap-correlation-attribute-pairs
     [--property {propertyName}] ...

To view the configuration for an existing LDAP Correlation Attribute Pair:

dsconfig get-ldap-correlation-attribute-pair-prop
     --pair-name {name}
     --view-name {name}
     --type-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing LDAP Correlation Attribute Pair:

dsconfig set-ldap-correlation-attribute-pair-prop
     --pair-name {name}
     --view-name {name}
     --type-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new LDAP Correlation Attribute Pair:

dsconfig create-ldap-correlation-attribute-pair
     --pair-name {name}
     --view-name {name}
     --type-name {name}
     --set primary-correlation-attribute:{propertyValue}
     --set secondary-correlation-attribute:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing LDAP Correlation Attribute Pair:

dsconfig delete-ldap-correlation-attribute-pair
     --pair-name {name}
     --view-name {name}
     --type-name {name}