Oracle Unified Directory - REST Web Service Extension

REST Web Service Extension

The REST Web Service Extension defines an extension that will be used by OUD to provide RESTful Web Services for the configured REST resources.

This extension defines the RESTful Web Service provider. When enabled, it will provide RESTful web services and make the configured REST resources available over HTTP.

Parent Component

The REST Web Service Extension component inherits from the Extension

Properties

A description of each property follows.

Basic Properties:	Advanced Properties:
↓ enabled	↓ authentication-schemes-documentation-url
↓ rest-context	↓ authentication-schemes-spec-url
	↓ bulk-max-operations
	↓ bulk-max-payload-size
	↓ bulk-supported
	↓ etag-supported
	↓ filter-max-results
	↓ filter-supported
	↓ java-class
	↓ patch-supported
	↓ rest-documentation-url
	↓ sort-supported

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

rest-context

Description	Specifies the RESTful web service context. REST Web Service Extension. The context root for the RESTful web service. For example /idaas/rest.
Default Value	/idaas/rest
Allowed Values	A String
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	No
Read-only	No

Advanced Properties

authentication-schemes-documentation-url

Description	Specifies the URL hosting the documentation for RESTful web services authentication schemes. The RESTful web services authentication schemes.
Default Value	http://www.oracle.com
Allowed Values	A String
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

authentication-schemes-spec-url

Description	Specifies the URL hosting the documentation for authentication schemes specifications. The documentation for authentication scheme specification for RESTful web services.
Default Value	http://www.oracle.com
Allowed Values	A String
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

bulk-max-operations

Description	Specifies the maximum number of allowable bulk operations. REST Web Service Extension. TODO
Default Value	1000
Allowed Values	An integer value. Lower value is 1.
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

bulk-max-payload-size

Description	Specifies the max payload size for the bulk operations while using REST Web Service Extension. TODO
Default Value	1000
Allowed Values	An integer value. Lower value is 1.
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

bulk-supported

Description	Whether or not the bulk operations are supported by this REST Web Service Extension. TODO
Default Value	true
Allowed Values	true false
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

etag-supported

Description	Specifies whether or not the etag is supported by this REST Web Service Extension. TODO.
Default Value	false
Allowed Values	true false
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

filter-max-results

Description	Specifies the maxium result size while using filters. REST Web Service Extension. The RESTful web service can restrict the results returned by the server to restrict the bandwidth, or for efficiency.
Default Value	1000
Allowed Values	An integer value. Lower value is 1.
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

filter-supported

Description	Specifies whether or not the Search filters will be supported by the web service. REST Web Service Extension. The search filters can be used while querying the RESTful resources.
Default Value	true
Allowed Values	true false
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

java-class

Description	Specifies the fully-qualified name of the Java class that provides the REST Web Service Extension implementation.
Default Value	com.oracle.scim.RESTWebServiceExtension
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 Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

patch-supported

Description	Specifies whether or not the PATCH operation is supported by the web service. REST Web Service Extension. The PATCH operation compares to an LDAP modify operation that supports changetype.
Default Value	true
Allowed Values	true false
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

rest-documentation-url

Description	Specifies the URL hosting the documentation for REST Web Service Extension. The REST web service is defined in the documentation.
Default Value	http://www.oracle.com
Allowed Values	A String
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No

sort-supported

Description	Specifies whether or not the sorting of the search results is supported by this REST Web Service Extension. REST Web Service Extension. TODO
Default Value	false
Allowed Values	true false
Multi-valued	No
Required	No
Admin Action Required	The REST Web Service Extension must be disabled and re-enabled for changes to this setting to take effect
Advanced Property	Yes
Read-only	No