User Activities
The User Activities API 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.
User activities data model
| Property | Type | Required? | Mutable? | Description |
|---|---|---|---|---|
|
Date |
N/A |
Read-only |
The start date for the activity period. |
|
Date |
N/A |
Read-only |
The end date for the activity period. |
|
String |
N/A |
Read-only |
The environment resource’s unique identifier. |
|
Integer |
N/A |
Read-only |
The total number of successful user sign ons for the activity period. |
|
Integer |
N/A |
Read-only |
The total number of failed user sign ons for the activity period. |
|
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. |