Configuration Reference Home
OpenDJ Server - Admin Endpoint

Admin Endpoint

The Admin Endpoint provides RESTful access to OpenDJ's monitoring and configuration backends.

Parent Component

The Admin Endpoint component inherits from the HTTP Endpoint

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ authorization-mechanism ↓ java-class
↓ base-path
↓ 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

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 Admin Endpoint implementation.
Default Value
org.opends.server.protocols.http.rest2ldap.AdminEndpoint
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