--- title: Hdap Endpoint description: The Hdap Endpoint provides a lightweight REST API for accessing all directory data. component: pingds version: 8.1 page_id: pingds:configref:objects-hdap-endpoint canonical_url: https://docs.pingidentity.com/pingds/8.1/configref/objects-hdap-endpoint.html section_ids: parent: Parent hdap_endpoint_properties: Hdap Endpoint properties basic_properties: Basic properties authorization-mechanism: authorization-mechanism base-path: base-path enabled: enabled normalize-attribute-names: normalize-attribute-names advanced_properties: Advanced properties java-class: java-class return-null-for-missing-properties: return-null-for-missing-properties --- # Hdap Endpoint The Hdap Endpoint provides a lightweight REST API for accessing all directory data. ## Parent The Hdap Endpoint object inherits from [HTTP Endpoint](objects-http-endpoint.html). ## Hdap Endpoint properties You can use configuration expressions to set property values at startup time. For details, see [Property value substitution](expressions.html). | Basic Properties | Advanced Properties | | ------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | [authorization-mechanism](#authorization-mechanism) [base-path](#base-path) [enabled](#enabled) [normalize-attribute-names](#normalize-attribute-names) | [java-class](#java-class) [return-null-for-missing-properties](#return-null-for-missing-properties) | ### 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](objects-http-authorization-mechanism.html).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* | truefalse | | *Multi-valued* | No | | *Required* | Yes | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ### normalize-attribute-names | | | | ----------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates if LDAP attribute names should be normalized in JSON resource names. | | *Description* | LDAP attributes often have multiple names (e.g. "cn" and "commonName") and the names are also case-insensitive. This option controls whether the attribute names in JSON resources should be normalized to a single consistent name, or whether they should be returned as-is from the LDAP entry or request. | | *Default value* | true | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | No | | *Read-only* | No | ## Advanced properties Use the `--advanced` option to access advanced properties. ### java-class | | | | ----------------------- | ---------------------------------------------------------------------------------------------------- | | *Synopsis* | Specifies the fully-qualified name of the Java class that provides the Hdap Endpoint implementation. | | *Default value* | org.opends.server.protocols.http.HdapEndpoint | | *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 | ### return-null-for-missing-properties | | | | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | *Synopsis* | Indicates whether missing JSON properties should be included in JSON resources. | | *Description* | By default JSON properties which are not present in the target LDAP entries are not included in JSON resources returned by the REST endpoint. Set this option to true if these JSON properties should be included. LDAP attributes that are defined as SINGLE-VALUE are returned as null, or as an empty array if not. | | *Default value* | false | | *Allowed values* | truefalse | | *Multi-valued* | No | | *Required* | No | | *Admin action required* | None | | *Advanced* | Yes | | *Read-only* | No |