To retrieve a list of entries under a subtree of an entry, use the {dn}/subtree
endpoint. This endpoint requires the searchScope
parameter. The supported search scopes are:
baseObject
Returns only the object directly described by the base DN.
singleLevel
Returns only the entries that are immediate children of the base entry.
wholeSubtree
Returns the base entry and all of its descendants.
subordinateSubtree
Returns the descendants of the base entry, but not the base entry itself.
All list requests are paged. The limit
parameter specifies the page size. However, the page size can be smaller than requested, either because the server has a configured maximum page size or because you have reached the last page and there are not enough entries to fill the page.
The next
link enables navigation forward from the current page to the next page. The directory service does not support a previous
link to move backward from the current page.
The size
value on the returned object shows the actual number of entries returned in the request.
The sample shows the GET /directory/v1/{dn}/subtree
operation to return the base entry and all of its descendants.