PingOne Platform APIs

Active Identity Counts

Active identity counts gather information about identities that have completed one of the following actions successfully during a specified period of time:

  • Authentication

    The identity has completed at least one authentication flow successfully.

  • Password check

    The identity has completed at least one Password Check successfully.

This service uses authentication and password-evaluation user events to determine whether an identity is active within a specified sampling period.

Currently, the active identity count does not return product-specific counts (such as, for PingOne SSO, MFA, or Protect), nor does it count active users when DaVinci is used.

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.

Active identity count errors

In addition to the general error codes, active 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: Parameter startDate can’t be null or empty. or Invalid cursor request parameter

When and details

When: A GET active identity counts request omits the startDate filter or specifies an invalid cursor.

Details: None.

400

INVALID_REQUEST

None

Message: Filter parameter startDate can’t be in the future.

When and details

When: A GET active identity counts request specifies a startDate filter that is later than the current date.

Details: None.

400

INVALID_REQUEST

None

Message: Filter parameter startDate can’t be earlier than 2 years ago.

When and details

When: A GET active identity counts request specifies a startDate filter that is more than 2 years earlier than the current date.

Details: None.

400

INVALID_REQUEST

None

Message: Wrong date time format in filter parameter - startDate. Correct date pattern is yyyy-MM-dd’T’HH:mm:ss.SSS’Z'

When and details

When: A GET active identity counts request specifies a startDate filter value that is not a valid date and time in yyyy-MM-dd’T’HH:mm:ss.SSS’Z' format.

Details: None.

400

INVALID_DATA

None

Message: <samplePeriod> is not a valid samplePeriod. Use one of [DAY, MONTH]

When and details

When: A GET active identity counts request specifies a samplePeriod value that is not DAY or MONTH.

Details: None.

400

INVALID_REQUEST

None

Message: Limit parameter should be in range (1 - 730) for DAY sample period parameter and (1 - 24) for MONTH

When and details

When: A GET active identity counts request specifies a limit value outside the range allowed for the sample period (1-730 for DAY, 1-24 for MONTH).

Details: None.

400

INVALID_REQUEST

None

Message: aggregatedBy request parameter must be specified. Available values: licenseYear, calendarMonth or limit parameter must be in range from 1 to 1000

When and details

When: A GET active identity counts by license request omits the aggregatedBy parameter or specifies a value that is not licenseYear or calendarMonth, or specifies a limit value outside the range 1-1000.

Details: None.

400

INVALID_DATA

None

Message: The message text varies with the filter evaluation error.

When and details

When: A GET active identity counts request specifies a filter value that the service cannot evaluate (for example, a malformed startDate filter expression).

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 for the active identity counts by date range operation or lacks the licensing:read:license permission for the active identity counts by license operation (GET operations).

Details: None.

404

NOT_FOUND

None

Message: The request could not be completed. The requested resource was not found.

When and details

When: A GET active identity counts by license request specifies a licenseId that does not exist or is not associated with the organizationId in the request path.

Details: None.

500

UNEXPECTED_ERROR

None

Message: Issue with fetching data from data server.

When and details

When: The service fails to fetch data from the data server.

Details: None.