PingOne Platform APIs

Query parameter quick reference

SCIM protocol filtering operators help you fine-tune requests that return a large number of items. The PingOne platform supports several SCIM operators. For the list of supported SCIM filtering operators, refer to Filtering collections conventions).

PingOne endpoint operations may support only a subset of SCIM filtering operators. In addition, the service may allow filtering only on specific attributes. For example, the /organizations endpoint allows filtering only on the name attribute using only the sw (starts with) operator.

This topic provides a quick reference to show the SCIM operators that apply to a given PingOne endpoint operation. It also provides information about endpoint operations that support the limit filter, the order filter, and the expand filter. For general information about page limits and collection ordering, refer to Paging, ordering, and filtering collections. For information about resource expansion, refer to the "Link expansion" section of HTTP methods conventions).

Endpoints that support SCIM filtering expressions

The following endpoint operations allow filtering with the indicated attributes and operators. Refer to Filtering collections conventions for SCIM operator names and descriptions.

Endpoint SCIM operators by attribute

/activeIdentityCounts

* startDate: ge

* samplingPeriod: eq

/activities

* recordedat: ge, gt, le, lt

* correlationid: eq

* actors.client.id: eq

* actors.user.id: eq

* actors.user.name: eq

* resources.id: eq

* resources.type: eq

* resources.population.id: eq

* action.type: eq

/applicationSignons

* occurredAt: ge

/environments

* name: sw

* id: eq

* organization.id: eq

/licenses

* beginsAt: lt

/populations

* name: sw

* id: eq

/environment/{{envID}}/roles

* type: eq

/templates

* createdAt: eq, ne, gt, ge, lt, le

* updatedAt: eq, ne, gt, ge, lt, le

* default: eq

* deliveryMethod: eq

/totalIdentities

* startDate: eq

* endDate: eq

/userActivities

* startDate: eq, gt, ge, lt, le

* endDate: eq, gt, ge, lt, le

/users

* enabled: eq

* population.id: eq

* {{customStringAttributes}}: eq, sw (refer to note below)

* linkedAccounts[identityProvider.id eq "{{identityProviderID}}"]

* linkedAccounts[externalId eq "{{externalID}}"]

* memberOfGroups[id eq "{{memberOfGroupID}}"]

* memberOfGroups[type eq "{{typeString}}"]

/users/{{userID}}/devices

* status: eq

* type: eq

For string attributes (and string sub-attributes like name.formatted), the eq and sw operators are available. This includes custom string attributes added to the user schema. Attribute names are case-sensitive. Text inside quotes are used for a case-insensitive search.

Endpoints that support resource expansion

The following endpoint operations support resource expansion using the expand={resource} filter.

Endpoint Target resource

/environments

* expand=billOfMaterials

/environments/{{envID}}

* expand=billOfMaterials

/environments/{{envID}}/apiServers/{{apiServerID}}/operations/{{apiServerOperationID}}

* expand=groups

* expand=scopes

* expand=authenticationPolicies

/environments/{{envID}}/applicationRoles/{{appRoleID}}/users

* expand=user

/environments/{{envID}}/dataExplorations

* expand=entries

/environments/{{envID}}/fido2Policies

* expand=deviceAuthenticationPolicies

/environments/{{envID}}/identityProviders/{{providerID}}

* expand=attributes

/resources

* expand=scopes

/resources/{{resourceID}}

* expand=scopes

/schemas/{{schemaID}}

* expand=attributes

/users

* expand=populations

/users/{{userID}}

* expand=populations

/users/{{userID}}/devices

* expand=order

* expand=typeDisplayNames

/users/{{userID}}/linkedAccounts

* expand=identityProviders

/users/{{userID}}/linkedAccounts/{{linkedAccountID}}

* expand=identityProvider

/users/{{userID}}/password

* expand=passwordPolicy

Endpoints that support ordering by attribute

The following endpoint operations support resource expansion using the order={attribute} filter.

Endpoint Attribute

/activeIdentityCounts

* order=startDate

/licenses

* order=beginsAt

/templates

* order=updatedAt

* order=createdAt

/templates/{{templateName}}/contents

* order=updatedAt

* order=createdAt

Endpoints that support page limits

The following endpoint operations support page limits using the limit filter. Refer to Paging, ordering, and filtering collections for more information.

For some requests, allowed limits are not always honored by the response. For example, the page size in the /environments/{{envID}}/users endpoint response may be smaller than the requested limit. Although limits up to 1000 are permitted for backward compatibility, a requested limit from 201 to 1000 will result in a response page size of 200. When determining the number of records returned per page, use the page size in the response rather than the requested limit.