PingAuthorize Server Documentation Index
Configuration Reference Home

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 Correlation Attribute Pair object defines an attribute pair that share a common value on a Primary and Secondary store adapter of a SCIM Resource Type.

Relations to This Component
Properties
dsconfig Usage

Relations to This Component

The following components have a direct composition relation to 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 primary Store Adapter whose value will be used to match objects in the secondary Store Adapter.
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 Store Adapter attribute from the secondary Store Adapter 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 Correlation Attribute Pairs:

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

To view the configuration for an existing Correlation Attribute Pair:

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

To update the configuration for an existing Correlation Attribute Pair:

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

To create a new Correlation Attribute Pair:

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

To delete an existing Correlation Attribute Pair:

dsconfig delete-correlation-attribute-pair
     --pair-name {name}
     --adapter-name {name}
     --type-name {name}