---
title: Plain SASL Mechanism Handler
description: The Plain SASL Mechanism Handler performs all processing related to SASL PLAIN authentication.
component: pingds
version: 8.1
page_id: pingds:configref:objects-plain-sasl-mechanism-handler
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-plain-sasl-mechanism-handler.html
section_ids:
  parent: Parent
  dependencies: Dependencies
  plain_sasl_mechanism_handler_properties: Plain SASL Mechanism Handler properties
  basic_properties: Basic properties
  enabled: enabled
  identity-mapper: identity-mapper
  advanced_properties: Advanced properties
  java-class: java-class
---

# Plain SASL Mechanism Handler

The Plain SASL Mechanism Handler performs all processing related to SASL PLAIN authentication.

The PLAIN SASL mechanism provides the ability for clients to authenticate using a username and password. This authentication is very similar to standard LDAP simple authentication, with the exception that it can authenticate based on an authentication ID (for example, a username) rather than requiring a full DN, and it can also include an authorization ID in addition to the authentication ID. Note that the SASL PLAIN mechanism does not make any attempt to protect the password.

## Parent

The Plain SASL Mechanism Handler object inherits from [SASL Mechanism Handler](objects-sasl-mechanism-handler.html).

## Dependencies

Plain SASL Mechanism Handlers depend on the following objects:

* [Identity Mapper](objects-identity-mapper.html)

## Plain SASL Mechanism Handler properties

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

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

### Basic properties

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

### enabled

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

### identity-mapper

|                         |                                                                                                                                                                                                                                   |
| ----------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies the name(s) of the identity mapper(s) that is to be used with this SASL mechanism handler to match the authentication or authorization ID included in the SASL bind request to the corresponding user in the directory. |
| *Default value*         | None                                                                                                                                                                                                                              |
| *Allowed values*        | The name of an existing [identity-mapper](objects-identity-mapper.html).The referenced identity mapper(s) must be enabled when the Plain SASL Mechanism Handler is enabled.                                                       |
| *Multi-valued*          | Yes                                                                                                                                                                                                                               |
| *Required*              | Yes                                                                                                                                                                                                                               |
| *Admin action required* | None                                                                                                                                                                                                                              |
| *Advanced*              | No                                                                                                                                                                                                                                |
| *Read-only*             | No                                                                                                                                                                                                                                |

## Advanced properties

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

### java-class

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