Configuration Reference Home
Oracle Unified Directory - REST Server Extension

REST Server Extension

The REST Server Extension defines an extension that defines the REST server that handles the RESTful request sent to the HTTP server.

This extension defines the REST server that provides RESTful web services over HTTP. When enabled, it will handle REST APIs that enable OUD to expose its services using REST.

Parent Component

The REST Server Extension component inherits from the Extension

Relations From this Component

The following components have a direct AGGREGATION relation FROM REST Server Extension :

Properties

A description of each property follows.


Basic Properties: Advanced Properties:
↓ enabled ↓ allow-entry-return
↓ end-point ↓ context-path
↓ http-authentication-scheme
↓ java-class
↓ lock-timeout
↓ skip-auth-context-path
↓ token-validity-period
↓ trust-manager-provider

Basic Properties

enabled

Description
Indicates whether the Extension is enabled.
Default Value
None
Allowed Values
true
false
Multi-valued
No
Required
Yes
Admin Action Required
None
Advanced Property
No
Read-only
No

end-point

Description
The HTTP end points that will be available through REST Server Extension . One or more end points can be enabled to provide RESTful web services.
Default Value
No end point will be available through the Directory Server.
Allowed Values
The DN of any End Point. The referenced end point must be enabled when the REST Server Extension is enabled.
Multi-valued
Yes
Required
No
Admin Action Required
None
Advanced Property
No
Read-only
No


Advanced Properties

allow-entry-return

Description
Enables to return an entry after successful ADD, Modify and ModifyDN operations. The HTTP server will return the entry back to the client once ADD, Modify or ModifyDN operations are performed. However, this value could be set to false when it may affect the performance such as modifying the large static groups, or adding a large entry may impact the response time. When this value is set to off, the entry could only be returned to the client if the post-read control is used as a part of the request.
Default Value
true
Allowed Values
true
false
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

context-path

Description
Specifies the HTTP context used for all RESTful services The REST Server Extension can be configured to use a custom HTTP context that defines a specific url. It must be set to a valid URL. The default context is /.
Default Value
The default context will set to /.
Allowed Values
A String
Multi-valued
No
Required
No
Admin Action Required
Restart the server
Advanced Property
Yes
Read-only
No

http-authentication-scheme

Description
The types of authentication scheme that will be used while accepting requests from REST clients over HTTP. One of more values can be configured for the HTTP authentication scheme. In case of more than one schemes, the authentication will be processed based onn the authorization header. Such as if both BASIC and ANONYMOUS authentication schemes are allowed, if the client sends a null authorization header, the REST Server Extension will not request for authorization but process all BASIC authentications sent with authorization headers.
Default Value
basic bearer
Allowed Values
anonymous - An anonymous request does not contain any authentication information.

basic - Basic authentication sends a Base64-encoded string that contains a user name and password for the client.

bearer - OAuth 2.0 authentication mechanism is a popular authentication mechamism that uses JWT bearer tokens.

client-cert - Client certificate-based authentication.


Multi-valued
Yes
Required
No
Admin Action Required
None. Changes to this setting take effect immediately.
Advanced Property
Yes
Read-only
No

java-class

Description
Specifies the fully-qualified name of the Java class that provides the REST Server Extension implementation.
Default Value
com.oracle.rest.RESTServerExtension
Allowed Values
A java class that implements or extends the class(es) :
org.opends.server.api.Extension
Multi-valued
No
Required
Yes
Admin Action Required
The REST Server Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property
Yes
Read-only
No

lock-timeout

Description
Specifies the length of time to wait while attempting to wait for a response from the LDAP server worker thread. The HTTP server will hand over the request to the LDAP server and block on the response from the server. The lock timeout defines how long should the HTTP server thread block on the LDAP worker thread before giving up. A value of 0 will wait forever. Choose an optimal value to avoid any deadlocks.
Default Value
60000.0ms
Allowed Values
A duration Syntax. A value of "-1" or "unlimited" for no limit. Lower limit is 0 milliseconds.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

skip-auth-context-path

Description
Specifies one or more context paths for which the authentication can be skipped. The REST Server Extension can be configured to use one or more context paths that may be left unprotected from the authentication. This may be helpful in hosting documents or help etc.
Default Value
None
Allowed Values
A String
Multi-valued
Yes
Required
No
Admin Action Required
None. Changes to this setting take effect immediately.
Advanced Property
Yes
Read-only
No

token-validity-period

Description
Specifies the time interval after the generated JWT bearer token becomes invalid.
Default Value
None
Allowed Values
A duration Syntax. A value of "-1" or "unlimited" for no limit. Lower limit is 1 minutes.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No

trust-manager-provider

Description
Specifies trust manager provider to use for the REST Server Extension to generate or validate OAuth 2.0 Bearer tokens. The referenced trust manager provider must be enabled to process Bearer tokens.
Default Value
JKS
Allowed Values
The DN of any Trust Manager Provider. The referenced trust manager provider must be enabled when the REST Server Extension is enabled and configured to use OAuth bearer authentication scheme.
Multi-valued
No
Required
No
Admin Action Required
None
Advanced Property
Yes
Read-only
No


Copyright © 2019, 2023, Oracle and/or its affiliates.