PingAuthorize Server Documentation Index
Configuration Reference Home

Store Adapter Mapping

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.

Store Adapter Mappings define a mapping between SCIM Resource Type attributes and Store Adapter attributes.

↓Relations from This Component
↓Relations to This Component
↓Properties
↓dsconfig Usage

Relations from This Component

The following components have a direct aggregation relation from Store Adapter Mappings:

Relations to This Component

The following components have a direct composition relation to Store Adapter Mappings:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ secondary-store-adapter  None
↓ scim-resource-type-attribute
↓ store-adapter-attribute
↓ readable
↓ writable
↓ searchable
↓ authoritative

Basic Properties

secondary-store-adapter

Description
The Store Adapter that persists the mapped SCIM Resource Type attribute(s).
Default Value
The primary Store Adapter persists the mapped SCIM Resource Type attribute(s).
Allowed Values
The DN of any Store Adapter. The referenced Store Adapter must be enabled.
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

scim-resource-type-attribute

Description
The attribute path of SCIM Resource Type attributes to be mapped. Examples of valid attribute paths are:
  • 'name' - Maps the 'name' core attribute.
  • 'urn:extension:organization' - Maps the 'organization' extended attribute from the schema extension 'urn:extension'.
  • '*' - Wildcard to map all core attributes that are not otherwise mapped.
  • 'urn:extension:*' - Wildcard to map all extended attributes from the schema extension 'urn:extension' that are not otherwise mapped.
  • 'addresses[type eq "preferred"].postalCode' - Maps the postalCode sub-attribute of the address core attribute where the sub-attribute type equals 'preferred'. Only the equality filter on the type sub-attribute is supported as the value filter.
When mapping from Store Adapter to SCIM Resource Type, wildcard mappings are performed first before the other mappings so the values from more specific mappings will have precedence when there is a conflict.
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

store-adapter-attribute

Description
The Store Adapter attribute to be mapped, or the path to a specific field of a Store Adapter attribute. Examples:
  • 'name' - Maps the 'name' attribute.
  • 'name.last' - Maps only the last name field of the 'name' attribute.

Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

readable

Description
Specifies whether the mapping is used to map from Store Adapter attribute to SCIM Resource Type attribute in a read operation.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

writable

Description
Specifies that the mapping is used to map from SCIM Resource Type attribute to Store Adapter attribute in a write operation.
Default Value
true
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

searchable

Description
Specifies that the mapping is used to map from SCIM Resource Type attribute to Store Adapter attribute in a search filter.
Default Value
false
Allowed Values
true
false
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

authoritative

Description
Specifies that the mapping is authoritative over other mappings for the same SCIM Resource Type attribute (for read operations).
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 Store Adapter Mappings:

dsconfig list-store-adapter-mappings
     [--property {propertyName}] ...

To view the configuration for an existing Store Adapter Mapping:

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

To update the configuration for an existing Store Adapter Mapping:

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

To create a new Store Adapter Mapping:

dsconfig create-store-adapter-mapping
     --mapping-name {name}
     --type-name {name}
     --set scim-resource-type-attribute:{propertyValue}
     --set store-adapter-attribute:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Store Adapter Mapping:

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