---
title: Rest2LDAP Endpoint (DEPRECATED)
description: "DEPRECATED for removal since 7.4.0: The new HDAP (HTTP Directory Access Protocol) feature provides access to LDAP data over HTTP. It improves over Rest2LDAP by providing direct access to hierarchical directory data in a way that is dynamic and discoverable, and greatly increases developer experience by working out-of-the-bo thanks to zero config approach. Alternative: Consider using HDAP, which is available as a preview feature since the 7.4 release."
component: pingds
version: 7.5
page_id: pingds:configref:objects-rest2ldap-endpoint
canonical_url: https://docs.pingidentity.com/pingds/7.5/configref/objects-rest2ldap-endpoint.html
section_ids:
  parent: Parent
  rest2ldap_endpoint_properties: Rest2LDAP Endpoint properties
  basic_properties: Basic properties
  authorization-mechanism: authorization-mechanism
  base-path: base-path
  config-directory: config-directory
  enabled: enabled
  advanced_properties: Advanced properties
  java-class: java-class
  return-null-for-missing-properties: return-null-for-missing-properties
---

# Rest2LDAP Endpoint (DEPRECATED)

|   |                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| - | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|   | DEPRECATED for removal since 7.4.0: The new HDAP (HTTP Directory Access Protocol) feature provides access to LDAP data over HTTP. It improves over Rest2LDAP by providing direct access to hierarchical directory data in a way that is dynamic and discoverable, and greatly increases developer experience by working out-of-the-bo thanks to zero config approach. Alternative: Consider using HDAP, which is available as a preview feature since the 7.4 release. |

The Rest2LDAP Endpoint provides RESTful access to LDAP application data using a set of customizable data transformations.

## Parent

The Rest2LDAP Endpoint object inherits from [HTTP Endpoint](objects-http-endpoint.html).

## Rest2LDAP Endpoint 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                                                                                 |
| ------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- |
| [authorization-mechanism](#authorization-mechanism) [base-path](#base-path) [config-directory](#config-directory) [enabled](#enabled) | [java-class](#java-class) [return-null-for-missing-properties](#return-null-for-missing-properties) |

### Basic properties

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

### authorization-mechanism

|                         |                                                                                                                                                                                             |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | The HTTP authorization mechanisms supported by this HTTP Endpoint.                                                                                                                          |
| *Default value*         | None                                                                                                                                                                                        |
| *Allowed values*        | The name of an existing [http-authorization-mechanism](objects-http-authorization-mechanism.html).The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled. |
| *Multi-valued*          | Yes                                                                                                                                                                                         |
| *Required*              | Yes                                                                                                                                                                                         |
| *Admin action required* | None                                                                                                                                                                                        |
| *Advanced*              | No                                                                                                                                                                                          |
| *Read-only*             | No                                                                                                                                                                                          |

### base-path

|                         |                                                                                                                                                  |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| *Synopsis*              | All HTTP requests matching the base path or subordinate to it will be routed to the HTTP endpoint unless a more specific HTTP endpoint is found. |
| *Default value*         | None                                                                                                                                             |
| *Allowed values*        | A string.                                                                                                                                        |
| *Multi-valued*          | No                                                                                                                                               |
| *Required*              | Yes                                                                                                                                              |
| *Admin action required* | None                                                                                                                                             |
| *Advanced*              | No                                                                                                                                               |
| *Read-only*             | Yes                                                                                                                                              |

### config-directory

|                         |                                                                                                                                                                                                                                              |
| ----------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| *Synopsis*              | The directory containing the Rest2Ldap configuration file(s) for this specific endpoint.                                                                                                                                                     |
| *Description*           | The directory must be readable by the server and may contain multiple configuration files, one for each supported version of the REST endpoint. If a relative path is used then it will be resolved against the server's instance directory. |
| *Default value*         | None                                                                                                                                                                                                                                         |
| *Allowed values*        | A directory that is readable by the server.                                                                                                                                                                                                  |
| *Multi-valued*          | No                                                                                                                                                                                                                                           |
| *Required*              | Yes                                                                                                                                                                                                                                          |
| *Admin action required* | None                                                                                                                                                                                                                                         |
| *Advanced*              | No                                                                                                                                                                                                                                           |
| *Read-only*             | No                                                                                                                                                                                                                                           |

### enabled

|                         |                                                 |
| ----------------------- | ----------------------------------------------- |
| *Synopsis*              | Indicates whether the HTTP Endpoint is enabled. |
| *Default value*         | None                                            |
| *Allowed values*        | truefalse                                       |
| *Multi-valued*          | No                                              |
| *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 Rest2LDAP Endpoint implementation. |
| *Default value*         | org.opends.server.protocols.http.rest2ldap.Rest2LdapEndpoint                                              |
| *Allowed values*        | A Java class that extends or implements:- org.opends.server.api.HttpEndpoint                              |
| *Multi-valued*          | No                                                                                                        |
| *Required*              | Yes                                                                                                       |
| *Admin action required* | None                                                                                                      |
| *Advanced*              | Yes                                                                                                       |
| *Read-only*             | No                                                                                                        |

### return-null-for-missing-properties

|                         |                                                                                                                                                                                                                                                        |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| *Synopsis*              | Indicates whether missing (unmapped) JSON properties should be included in JSON resources.                                                                                                                                                             |
| *Description*           | By default JSON properties that do not have a corresponding LDAP attribute are unmapped and not included in JSON resources returned by the REST endpoint. Set this option to true if unmapped JSON properties should be included with a value of null. |
| *Default value*         | false                                                                                                                                                                                                                                                  |
| *Allowed values*        | truefalse                                                                                                                                                                                                                                              |
| *Multi-valued*          | No                                                                                                                                                                                                                                                     |
| *Required*              | No                                                                                                                                                                                                                                                     |
| *Admin action required* | None                                                                                                                                                                                                                                                   |
| *Advanced*              | Yes                                                                                                                                                                                                                                                    |
| *Read-only*             | No                                                                                                                                                                                                                                                     |