Common REST and IDM
IDM implements the Common REST API as described in the previous section, with the exception of the following elements:
IDM provides limited support for the
inexpression clause. You can use this clause for queries on singleton string properties, not arrays.
inquery expressions are not supported through the Admin UI.
transformaction is supported only on the
configendpoint. Note that this is an optional action and not implemented everywhere across the ForgeRock Identity Platform.
Common REST supports PATCH operations by list element index, as shown in the example in "Patch Operation: Remove". IDM does not support PATCH by list element index. So, for PATCH ADD operations, you cannot use an ordinal when adding items to a list. You can add an item using the special hyphen index, which designates that the element should be added to the end of the list.
_fieldsis left blank (null), the server returns all default values. In IDM, this excludes relationships and virtual fields. To include these fields in the output, add
"returnByDefault" : truein the applicable schema.
IDM also implements wild-card (
*) handling with the
_fieldsparameter. So, a value of
_fields=*_refwill return all relationship fields associated with an object. A value of
_fields=*_ref/*will return all the fields within each relationship.
IDM does not implement the
ESTIMATEtotal paged results policy. The
totalPagedResultsis either the exact total result count (
_totalPagedResultsPolicy=EXACT) or result counting is disabled (
_totalPagedResultsPolicy=NONE). For more information, see "Page Query Results".