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.

Note: this is an abstract component that cannot be instantiated.

Identity Mappers are responsible for establishing a mapping between an identifier string provided by a client, and the entry for the user that corresponds to that identifier. Identity Mappers are used to process several SASL mechanisms to map an authorization ID (e.g., a Kerberos principal when using GSSAPI) to a directory user. They are also used when processing requests with the proxied authorization control.

↓Direct Subcomponents
↓Relations to This Component
↓Properties
↓dsconfig Usage

Direct Subcomponents

The following Identity Mappers are available in the server :

• Exact Match Identity Mapper
• Regular Expression Identity Mapper
• Scripted Identity Mapper
• Third Party Identity Mapper

These Identity Mappers inherit from the properties described below.

Relations to This Component

The following components have a direct aggregation relation to Identity Mappers:

• Config HTTP Servlet Extension

• Cram MD5 SASL Mechanism Handler

• Digest MD5 SASL Mechanism Handler

• Directory REST API HTTP Servlet Extension

• File Server HTTP Servlet Extension

• Global Configuration

• GSSAPI SASL Mechanism Handler

• Plain SASL Mechanism Handler

• Third Party SASL Mechanism Handler

• UnboundID TOTP SASL Mechanism Handler

• UnboundID Yubikey OTP SASL Mechanism Handler

Properties

The properties supported by this managed object are as follows:

Basic Properties

description

enabled

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 delete an existing Identity Mapper:

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