The OpenDJ REST API is built on a common ForgeRock HTTP-based REST API for interacting with JSON Resources. APIs built on this common layer all let you perform the following operations.
- Create
-
Add a resource that does not yet exist
- Read
-
Retrieve a single resource
- Update
-
Replace an existing resource
- Delete
-
Remove an existing resource
- Patch
-
Modify part of an existing resource
- Action
-
Perform a predefined action
- Query
-
List a set of resources
- modifyPassword
-
Change Your Password
- resetPassword
-
Reset a Password
The present implementation in OpenDJ maps JSON resources onto LDAP entries, meaning REST clients can in principle do just about anything an LDAP client can do with directory data.
In addition to query string parameters that depend on the operation, the examples in this chapter make use of the following parameters that apply to the JSON resource returned for all operations.
_fields=field[,…]-
Retain only the specified fields in the JSON resource returned.
_prettyPrint=true|false-
Make the JSON resource returned easy for humans to read.
