PingDirectory

Sort and filter objects

The Configuration API supports System for Cross-domain Identity Management (SCIM) parameters for filter, sorting, and pagination.

Search operations can specify a SCIM filter 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. Include or exclude attributes can be specified in both GET and list operations.

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=exmple,dc=com".

sortBy

Specifies a property value by which to sort.

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.