REST and Advanced Identity Cloud

Representational State Transfer (REST) is a software architecture style for exposing resources, using the technologies and protocols of the World Wide Web. REST describes how distributed data objects, or resources, can be defined and addressed.

Advanced Identity Cloud provides a RESTful API for accessing managed objects, system objects, workflows, and the system configuration.

Identity management implements the Advanced Identity Cloud REST API as described in the previous section, with the exception of the following elements:

Advanced Identity Cloud provides limited support for the in expression clause. You can use this clause for queries on singleton string properties, not arrays. in query expressions are not supported through the admin console.
The PATCH transform action is supported only on the config endpoint. Note that this is an optional action and not implemented everywhere across the Identity Platform.
Advanced Identity Cloud REST supports PATCH operations by list element index, as shown in the example in Patch. Advanced Identity Cloud does not support PATCH by list element index. So, for PATCH operations, you can’t use an ordinal when adding or removing list items.

You can add an item using the special hyphen index, which designates that the element should be added to the end of the list. To remove specific items from a list, you must specify the value to be removed, for example:
```
[
    {
        "operation" : "remove",
        "field" : "/phoneNumber/",
        "value" : "202-555-0185"
    }
]
```
When you remove items in this way, if the list contains two or more items with the same value, they are all removed.
If _fields is left blank (null), the server returns all default values. In Advanced Identity Cloud, this excludes relationships and virtual fields. To include these fields in the output, add "returnByDefault" : true in the applicable schema.

Advanced Identity Cloud also implements wildcard (*) handling with the _fields parameter. The value of _fields=*_ref returns all relationship fields associated with an object. A value of _fields=*_ref/* returns all the fields within each relationship.
If a total paged results policy is requested, Advanced Identity Cloud attempts to fulfill the request as either the exact total result count (_totalPagedResultsPolicy=EXACT) or an estimated total result count (_totalPagedResultsPolicy=ESTIMATE), depending on what the underlying repository supports. If the repository can’t fulfill the request, totalPagedResults returns -1. Learn more in Page query results.
The _countOnly parameter is supported for managed object queries, such as managed/realm-name_user, but not for managed object relationship queries, such as managed/realm-name_user/bob/roles.

PingOne Advanced Identity Cloud

REST and Advanced Identity Cloud