---
title: Identity Mapper
description: This is an abstract object type that cannot be instantiated.
component: pingds
version: 8.1
page_id: pingds:configref:objects-identity-mapper
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-identity-mapper.html
section_ids:
  identity_mappers: Identity Mappers
  dependencies: Dependencies
  identity_mapper_properties: Identity Mapper properties
  basic_properties: Basic properties
  enabled: enabled
  java-class: java-class
---

# Identity Mapper

*This is an abstract object type 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.

## Identity Mappers

The following Identity Mappers are available:

* [Exact Match Identity Mapper](objects-exact-match-identity-mapper.html)

* [Regular Expression Identity Mapper](objects-regular-expression-identity-mapper.html)

These Identity Mappers inherit the properties described below.

## Dependencies

The following objects depend on Identity Mappers:

* [CRAM-MD5 SASL Mechanism Handler](objects-cram-md5-sasl-mechanism-handler.html)

* [DIGEST-MD5 SASL Mechanism Handler](objects-digest-md5-sasl-mechanism-handler.html)

* [Global Configuration](objects-global.html)

* [GSSAPI SASL Mechanism Handler](objects-gssapi-sasl-mechanism-handler.html)

* [HTTP Basic Authorization Mechanism](objects-http-basic-authorization-mechanism.html)

* [Password Modify Extended Operation Handler](objects-password-modify-extended-operation-handler.html)

* [Plain SASL Mechanism Handler](objects-plain-sasl-mechanism-handler.html)

* [SCRAM-SHA-256 SASL Mechanism Handler](objects-scram-sha256-sasl-mechanism-handler.html)

* [SCRAM-SHA-512 SASL Mechanism Handler](objects-scram-sha512-sasl-mechanism-handler.html)

## Identity Mapper properties

You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html).

| Basic Properties                              |
| --------------------------------------------- |
| [enabled](#enabled) [java-class](#java-class) |

### Basic properties

Use the `--advanced` option to access advanced properties.

### enabled

|                         |                                                           |
| ----------------------- | --------------------------------------------------------- |
| *Synopsis*              | Indicates whether the Identity Mapper is enabled for use. |
| *Default value*         | None                                                      |
| *Allowed values*        | truefalse                                                 |
| *Multi-valued*          | No                                                        |
| *Required*              | Yes                                                       |
| *Admin action required* | None                                                      |
| *Advanced*              | No                                                        |
| *Read-only*             | No                                                        |

### java-class

|                         |                                                                                                        |
| ----------------------- | ------------------------------------------------------------------------------------------------------ |
| *Synopsis*              | Specifies the fully-qualified name of the Java class that provides the Identity Mapper implementation. |
| *Default value*         | None                                                                                                   |
| *Allowed values*        | A Java class that extends or implements:- org.opends.server.api.IdentityMapper                         |
| *Multi-valued*          | No                                                                                                     |
| *Required*              | Yes                                                                                                    |
| *Admin action required* | The object must be disabled and re-enabled for changes to take effect.                                 |
| *Advanced*              | No                                                                                                     |
| *Read-only*             | No                                                                                                     |