PingDirectory

Sorting and filtering configuration objects

The Configuration API supports SCIM parameters for filter, sorting, and pagination. Search operations can specify a SCIM filter used to narrow the number of elements returned. See the SCIM specification for the full set of operations for SCIM filters. Clients can also specify sort parameters or paging parameters, and attributes to include or exclude in both get and list operations.

GET Parameters for sorting and filtering
GET Parameter Description

filter

Values can be simple SCIM filters such as id eq "userRoot" or compound filters like meta.resourceType eq "Local DB Backend" and baseDn co"dc=example,dc=com".

sortBy

Specifies a property value to sort by.

sortOrder

Specifies either ascending or descending alphabetical order.

startIndex

1-based index of the first result to return.

count

Indicates the number of results per page.