Name

dsconfig list-http-endpoints — Lists existing HTTP Endpoints

Synopsis

dsconfig list-http-endpoints {options}

Options

The dsconfig list-http-endpoints command takes the following options:

--property {property}

The name of a property to be displayed.

-z | --unit-size {unit}

Display size data using the specified unit. The value for UNIT can be one of b, kb, mb, gb, or tb (bytes, kilobytes, megabytes, gigabytes, or terabytes).

HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the {unit} you provide.

By default, OpenDJ directory server supports the following HTTP Endpoint types:

admin-endpoint

Default {unit}: Admin Endpoint

Enabled by default: true

See the section called “Admin Endpoint” for the properties of this HTTP Endpoint type.

rest2ldap-endpoint

Default {unit}: Rest2ldap Endpoint

Enabled by default: true

See the section called “Rest2ldap Endpoint” for the properties of this HTTP Endpoint type.

-m | --unit-time {unit}

Display time data using the specified unit. The value for UNIT can be one of ms, s, m, h, d, or w (milliseconds, seconds, minutes, hours, days, or weeks).

HTTP Endpoint properties depend on the HTTP Endpoint type, which depends on the {unit} you provide.

By default, OpenDJ directory server supports the following HTTP Endpoint types:

admin-endpoint

Default {unit}: Admin Endpoint

Enabled by default: true

See the section called “Admin Endpoint” for the properties of this HTTP Endpoint type.

rest2ldap-endpoint

Default {unit}: Rest2ldap Endpoint

Enabled by default: true

See the section called “Rest2ldap Endpoint” for the properties of this HTTP Endpoint type.

Rest2ldap Endpoint

HTTP Endpoints of type rest2ldap-endpoint have the following 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

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 (Use --advanced in interactive mode.)

Read-only

No