Rest2LDAP Endpoint
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.
Rest2LDAP Endpoint Properties
You can use configuration expressions to set property values at startup time. For details, see Property Value Substitution.
| Basic Properties | 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. 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 |
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:
|
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 |
true false |
Multi-valued |
No |
Required |
No |
Admin Action Required |
None |
Advanced |
Yes |
Read-Only |
No |