Configuration Reference Home
OpenDJ Server - Rest2ldap Endpoint

Rest2ldap Endpoint

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

Parent Component

The Rest2ldap Endpoint component inherits from the HTTP Endpoint

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ authorization-mechanism ↓ java-class
↓ base-path
↓ config-directory
↓ enabled

Basic Properties

authorization-mechanism

Description
The HTTP authorization mechanisms supported by this HTTP Endpoint.
Default Value
None
Allowed Values
The DN of any HTTP Authorization Mechanism. The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled.
Multi-valued
Yes
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

base-path

Description
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 Property
No
Read-only
Yes

config-directory

Description
The directory containing the Rest2Ldap configuration file(s) for this specific endpoint.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 Property
No
Read-only
No

enabled

Description
Indicates whether the HTTP Endpoint is enabled.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

java-class

Description
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 implements or extends the class(es) :
org.opends.server.api.HttpEndpoint
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
Yes
Read-only
No