PingAuthorize Server Documentation Index
Configuration Reference Home

Aggregate Identity Mapper

Note: this component is designated "advanced", which means that objects of this type are not expected to be created or altered in most environments. If you believe that such a change is necessary, you may want to contact support in order to understand the potential impact of that change.

Aggregate Identity Mapper create Boolean combinations of multiple other identity mappers.

Parent Component
Relations from This Component
Properties
dsconfig Usage

Parent Component

The Aggregate Identity Mapper component inherits from the Identity Mapper

Relations from This Component

The following components have a direct aggregation relation from Aggregate Identity Mappers:

Properties

The properties supported by this managed object are as follows:


Basic Properties: Advanced Properties:
↓ description  None
↓ enabled
↓ all-included-identity-mapper
↓ any-included-identity-mapper

Basic Properties

description

Description
A description for this Identity Mapper
Default Value
None
Allowed Values
A string
Multi-Valued
No
Required
No
Admin Action Required
None. Modification requires no further action

enabled

Description
Indicates whether the Identity Mapper is enabled for use.
Default Value
None
Allowed Values
true
false
Multi-Valued
No
Required
Yes
Admin Action Required
None. Modification requires no further action

all-included-identity-mapper

Description
The set of identity mappers that must all match the target entry. Each identity mapper must uniquely match the same target entry. If any of the identity mappers match multiple entries, if any of them match zero entries, or if any of them match different entries, then the mapping will fail.
Default Value
None
Allowed Values
The DN of any Identity Mapper.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action

any-included-identity-mapper

Description
The set of identity mappers that will be used to identify the target entry. At least one identity mapper must uniquely match an entry. If multiple identity mappers match entries, then they must all uniquely match the same entry. If none of the identity mappers match any entries, if any of them match multiple entries, or if any of them match different entries, then the mapping will fail.
Default Value
None
Allowed Values
The DN of any Identity Mapper.
Multi-Valued
Yes
Required
No
Admin Action Required
None. Modification requires no further action


dsconfig Usage

To list the configured Identity Mappers:

dsconfig list-identity-mappers
     [--property {propertyName}] ...

To view the configuration for an existing Identity Mapper:

dsconfig get-identity-mapper-prop
     --mapper-name {name}
     [--tab-delimited]
     [--script-friendly]
     [--property {propertyName}] ...

To update the configuration for an existing Identity Mapper:

dsconfig set-identity-mapper-prop
     --mapper-name {name}
     (--set|--add|--remove) {propertyName}:{propertyValue}
     [(--set|--add|--remove) {propertyName}:{propertyValue}] ...

To create a new Aggregate Identity Mapper:

dsconfig create-identity-mapper
     --mapper-name {name}
     --type aggregate
     --set enabled:{propertyValue}
     [--set {propertyName}:{propertyValue}] ...

To delete an existing Identity Mapper:

dsconfig delete-identity-mapper
     --mapper-name {name}