PingOne Platform APIs

User Activities

The User Activities service returns counts for successful and failed sign-on actions as well as a count for password resets over a designated period of time. The service uses stream processors that listen to users and login_attempts events. These events are collected and presented by time period. The service supports the SCIM startDate, endDate, and sampleSize query filtering parameters to request user-activity information for a specific date range and sample size.

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.

User activities data model

Property Type Required Mutable Description

startDate

Date

N/A

Read-only

The start date for the activity period.

endDate

Date

N/A

Read-only

The end date for the activity period.

environment.id

String

N/A

Read-only

The environment resource’s unique identifier.

userSignOns.successes

Integer

N/A

Read-only

The total number of successful user sign ons for the activity period.

userSignOns.failures

Integer

N/A

Read-only

The total number of failed user sign ons for the activity period.

passwordResets

Integer

N/A

Read-only

The total number of password resets for the activity period.

Response codes

Code Message

200

Successful operation.

201

Successfully created.

204

Successfully removed. No content.

400

The request could not be completed.

401

You do not have access to this resource.

404

The requested resource was not found.

You need the Environment Admin or the Identity Data Admin role to read user activities resources.

User activity errors

In addition to the general error codes, user activity operations can return the following errors:

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

400

INVALID_DATA

None

Message: Filter parameter is wrong. Issue with startDate or Filter parameter is wrong. Issue with endDate

When and details

When: A GET user activities request specifies a startDate or endDate filter value that is not a valid ISO 8601 date and time.

Details: None.

400

INVALID_DATA

None

Message: start date can not be greater than end date

When and details

When: A GET user activities request specifies a startDate filter value that is later than the endDate filter value.

Details: None.

400

INVALID_DATA

None

Message: Filter parameter is wrong. Issue with sampleSize. sampleSize can be [HOUR, DAY, WEEK]

When and details

When: A GET user activities request specifies a sampleSize filter value that is not HOUR, DAY, or WEEK.

Details: None.

400

INVALID_DATA

None

Message: The query parameters provided were invalid or Fail to extract value <parameter> from filter

When and details

When: A GET user activities request specifies a filter expression the service cannot process, such as an operator other than eq or and, or a filter value that cannot be extracted.

Details: None.

401

ACCESS_FAILED

None

Message: The request could not be completed. You do not have access to this resource.

When and details

When: The request omits a valid bearer token.

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), which corresponds to the Environment Admin or Identity Data Admin role.

Details: None.

500

UNEXPECTED_ERROR

None

Message: Could not connect to cassandra

When and details

When: The service cannot connect to the data store.

Details: None.