---
title: SASL Mechanism Handler
description: This is an abstract object type that cannot be instantiated.
component: pingds
version: 8.1
page_id: pingds:configref:objects-sasl-mechanism-handler
canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-sasl-mechanism-handler.html
section_ids:
  sasl_mechanism_handlers: SASL Mechanism Handlers
  sasl_mechanism_handler_properties: SASL Mechanism Handler properties
  basic_properties: Basic properties
  enabled: enabled
  java-class: java-class
---

# SASL Mechanism Handler

*This is an abstract object type that cannot be instantiated.*

The SASL mechanism handler configuration entry is the parent for all SASL mechanism handlers defined in the PingDS directory server.

SASL mechanism handlers are responsible for authenticating users during the course of processing a SASL (Simple Authentication and Security Layer, as defined in RFC 4422) bind.

## SASL Mechanism Handlers

The following SASL Mechanism Handlers are available:

* [Anonymous SASL Mechanism Handler](objects-anonymous-sasl-mechanism-handler.html)

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

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

* [External SASL Mechanism Handler](objects-external-sasl-mechanism-handler.html)

* [GSSAPI SASL Mechanism Handler](objects-gssapi-sasl-mechanism-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)

These SASL Mechanism Handlers inherit the properties described below.

## 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                              |
| --------------------------------------------- |
| [enabled](#enabled) [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                                                               |

### java-class

|                         |                                                                                                               |
| ----------------------- | ------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | Specifies the fully-qualified name of the Java class that provides the SASL mechanism handler implementation. |
| *Default value*         | None                                                                                                          |
| *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*              | No                                                                                                            |
| *Read-only*             | No                                                                                                            |