dsconfig set-http-endpoint-prop — Modifies HTTP Endpoint properties
dsconfig set-http-endpoint-prop
{options}
The dsconfig set-http-endpoint-prop command takes the following options:
--endpoint-name {name}
The name of the HTTP Endpoint.
HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the {name} you provide.
By default, OpenDJ directory server supports the following HTTP Endpoint types:
Default {name}: Admin Endpoint
Enabled by default: true
See the section called “Admin Endpoint” for the properties of this HTTP Endpoint type.
Default {name}: Rest2ldap Endpoint
Enabled by default: true
See the section called “Rest2ldap Endpoint” for the properties of this HTTP Endpoint type.
--set {PROP:VALUE}
Assigns a value to a property where PROP is the name of the property and VALUE is the single value to be assigned. Specify the same property multiple times in order to assign more than one value to it.
HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the --endpoint-name {name}
option.
--reset {property}
Resets a property back to its default values where PROP is the name of the property to be reset.
HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the --endpoint-name {name}
option.
--add {PROP:VALUE}
Adds a single value to a property where PROP is the name of the property and VALUE is the single value to be added.
HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the --endpoint-name {name}
option.
--remove {PROP:VALUE}
Removes a single value from a property where PROP is the name of the property and VALUE is the single value to be removed.
HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the --endpoint-name {name}
option.
HTTP Endpoints of type admin-endpoint have the following properties:
The HTTP authorization mechanisms supported by this HTTP Endpoint.
None
The DN of any HTTP Authorization Mechanism. The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled.
Yes
Yes
None
No
No
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.
None
A String
No
Yes
None
No
Yes
Indicates whether the HTTP Endpoint is enabled.
None
true
false
No
Yes
None
No
No
Specifies the fully-qualified name of the Java class that provides the Admin Endpoint implementation.
org.opends.server.protocols.http.rest2ldap.AdminEndpoint
A Java class that implements or extends the class(es): org.opends.server.api.HttpEndpoint
No
Yes
None
Yes (Use --advanced in interactive mode.)
No
HTTP Endpoints of type rest2ldap-endpoint have the following properties:
The HTTP authorization mechanisms supported by this HTTP Endpoint.
None
The DN of any HTTP Authorization Mechanism. The referenced authorization mechanism must be enabled when the HTTP Endpoint is enabled.
Yes
Yes
None
No
No
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.
None
A String
No
Yes
None
No
Yes
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.
None
A directory that is readable by the server.
No
Yes
None
No
No
Indicates whether the HTTP Endpoint is enabled.
None
true
false
No
Yes
None
No
No
Specifies the fully-qualified name of the Java class that provides the Rest2ldap Endpoint implementation.
org.opends.server.protocols.http.rest2ldap.Rest2LdapEndpoint
A Java class that implements or extends the class(es): org.opends.server.api.HttpEndpoint
No
Yes
None
Yes (Use --advanced in interactive mode.)
No