PingOne Platform APIs

Total Identities

The total identities service retrieves the count of unique identities associated with a specified environment. The response shows the total number of users, divided into daily (24-hour) reporting periods, from the specified startDate through the endDate. The total identities count tracks the add and delete user operations to determine the changes in total number of unique identities over each 24-hour period. This service uses a SCIM query filter to control the sample size, showing the unique identity counts (on a per day basis) within the specified date range.

Assigning admin roles and permissions to this service

Admin role assignments determine access to PingOne APIs. When assigning admin roles to this service, refer to PingOne Permissions by Service for the service-specific permissions.

You can also choose to assign admin roles based on particular service resources. Refer to PingOne Permissions by Resource when assigning admin roles per service resources.

Admin assignments to roles are set by:

Refer to Roles Management for more information.

Total identities data model

Property Type Required Mutable Description

date

Date

N/A

Read-only

The date and time the total identities count starts for the sampling period (ISO 8601 format).

totalIdentities

Integer

N/A

Read-only

The total unique identities count for the sampling period.

The count attribute in the response data shows the current number of unique identities for the environment. For more information, see For more information, refer to Conventions.

Response codes

Code Message

200

Successful operation.

400

The request could not be completed.

401

You do not have access to this resource.

403

You do not have permissions or are not licensed to make this request.

404

The requested resource was not found.

500

Internal server error.

Total identity count errors

In addition to the general error codes, total identity count operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_REQUEST

None

Message: Neither Start or End Date are set. You need to set at least one!, Start Date cannot be after End Date!, or Unable to parse Start Date: '<value>' or Unable to parse End Date: '<value>'

When and details

When: A GET total identities request omits both the startDate and endDate filter values, specifies a startDate that is later than the endDate, or specifies a date value that cannot be parsed.

Details: None.

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the orgmgt:read:environment permission (GET operation).

Details: None.

500

UNEXPECTED_ERROR

None

Message: The message text varies with the data access failure.

When and details

When: The service fails to read the total identity counts from the data store.

Details: None.