The Rest2LDAP Endpoint provides RESTful access to LDAP application data using a set of customizable data transformations.
The Rest2LDAP Endpoint object inherits from HTTP Endpoint.
Use the --advanced
option to access advanced properties.
Basic Properties
Advanced Properties
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 |
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 |
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 |
Synopsis | Indicates whether the HTTP Endpoint is enabled. |
Default Value | None |
Allowed Values | true false |
Multi-valued | No |
Required | Yes |
Admin Action Required | None |
Advanced | No |
Read-Only | No |
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 |