PingDS 7.5.0

HTTP Endpoint

This is an abstract object type that cannot be instantiated.

The HTTP Endpoint is used to define HTTP endpoint.

HTTP Endpoints

The following HTTP Endpoints are available:

These HTTP Endpoints inherit the properties described below.

Dependencies

HTTP Endpoints depend on the following objects:

HTTP Endpoint properties

You can use configuration expressions to set property values at startup time. For details, see Property value substitution.

Basic Properties

authorization-mechanism
base-path
enabled
java-class

Basic properties

Use the --advanced option to access 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

enabled

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

java-class

Synopsis

Specifies the fully-qualified name of the Java class that provides the HTTP Endpoint implementation.

Default value

None

Allowed values

A Java class that extends or implements:

  • org.opends.server.api.HttpEndpoint

Multi-valued

No

Required

Yes

Admin action required

None

Advanced

No

Read-only

No

Copyright © 2010-2024 ForgeRock, all rights reserved.