PingAuthorize Server Documentation Index
Configuration Reference Home

Secondary Store Adapter

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.

Secondary Store Adapters persist a subset of attributes for a SCIM Resource Type.

Relations from This Component
Relations to This Component
Properties
dsconfig Usage

Relations from This Component

The following components have a direct composition relation from Secondary Store Adapters:

The following components have a direct aggregation relation from Secondary Store Adapters:

Relations to This Component

The following components have a direct composition relation to Secondary Store Adapters:

Properties

The properties supported by this managed object are as follows:


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

Basic Properties

store-adapter (Read-Only)

Description
A reference to the Store Adapter.
Default Value
None
Allowed Values
The DN of any Store Adapter. The referenced Store Adapter must be enabled.
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

primary-correlation-attribute

Description
A Store Adapter attribute from the primary Store Adapter whose value will be used to match objects in the secondary Store Adapter. If multiple correlation attributes are required they may be created using additional correlation-attribute-pairs.
Default Value
The id-attribute configured for the SCIM Resource Type will be used.
Allowed Values
A string
Multi-Valued
No
Required
No
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 with the primary-correlation-attribute. If multiple correlation attributes are required they may be specified by creating additional correlation-attribute-pairs. 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 Secondary Store Adapters:

dsconfig list-secondary-store-adapters
     [--property {propertyName}] ...

To view the configuration for an existing Secondary Store Adapter:

dsconfig get-secondary-store-adapter-prop
     --adapter-name {name}
     --type-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Secondary Store Adapter:

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

To create a new Secondary Store Adapter:

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

To delete an existing Secondary Store Adapter:

dsconfig delete-secondary-store-adapter
     --adapter-name {name}
     --type-name {name}