Active identity counts


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.

Filtering result data

The GET request for active identity counts requires a SCIM filter to specify start and end dates for the result data (or a start date and a sampling period value). For example, this SCIM filter returns active identity counts divided into time periods of one hour from the start date of “2019-01-01” to the current date by 10 records (periods) per page:

https://api.pingone.com/v1/environments/{environmentId}/activeIdentityCounts?limit=10&filter=startDate ge "2019-01-01T00:00:00Z" AND samplingPeriod eq 1

These SCIM operators can be applied to the following attributes:

  • eq (equals)

    Supported attributes: samplingPeriod

  • ge (greater than or equal to)

    Supported attributes: startDate

  • and (logical AND)

    Logical AND for building compound expressions in which both expressions are true.

Note: These SCIM operators are not supported: gt (greater than), lt (less than), le (less than or equal to), ne (not equal), co (contains), ew (ends with), in (includes), pr (present, is a non-empty or non-null value), sw (starts with), or (logical OR), not (logical NOT).

For more information about SCIM syntax and operators, see Conventions. For information about paging, ordering, and limiting collections, see Paging, ordering, and filtering collections.

Active identity counts API operations

The active identity counts endpoint supports the following operations:

For hands-on experience with the active identity counts API endpoints, click the Run in Postman button below to download a Postman collection that you can import and open in your local Postman application.

Active identity counts data model

Property Description
cumulative An integer that represents the cumulative count of unique active identities from the startDate specified in the request to the endDate of the current samplingPeriod.
endDate The date and time active identity count data collection ends (ISO 8601 format).
startDate The date and time active identity count data collection starts (ISO 8601 format).
value An integer that specifies the active identity count for the specified time period.

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.

Endpoint examples

Get active identity counts

You can get active identity counts for a selected environment over a specified time period. The GET /environments/{environmentId}/activeIdentityCounts request must specify a SCIM filtering expression that designates a time range or a sampling period in the request URL.

The following sample shows the GET /environments/{environmentId}/activeIdentityCounts?filter=startDate ge "2019-05-01T19:00:00Z" and samplingPeriod eq "10"&limit=10&order=-startDate" operation to return a maximum of 10 active identity counts for the sampling period from the specified start date.

curl -vX GET "https://api.pingone.com/v1/environments/{environmentId}/activeIdentityCounts?filter=startDate%20ge%20%222019-05-01T19:00:00Z%22%20and%20samplingPeriod%20eq%20%2210%22&limit=10&order=-startDate" \
-H "Authorization: Bearer jwtToken"

The response data looks like this:

{
    "_links": {
        "next": {
            "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activeIdentityCounts?cursor=ewogICJzdGFydFBlcmlvZCIgOiAiMjAxOS0wNS0wM1QyMTowMFoiLAogICJlbmRQZXJpb2QiIDogIjIwMTktMDQtMjlUMTc6MDBaIiwKICAiZW5kRGF0ZSIgOiAiMjAxOS0wNS0wN1QyMToxNTowOC4wNDRaIiwKICAibGFzdEN1bXVsYXRpdmUiIDogMCwKICAiZGVzY2VuZGluZyIgOiB0cnVlLAogICJsaW1pdCIgOiAxMCwKICAic3RhcnREYXRlIiA6ICIyMDE5LTA1LTAxVDE5OjAwWiIsCiAgInNhbXBsaW5nUGVyaW9kIiA6IDEwCn0%3D"
        },
        "self": {
            "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activeIdentityCounts?filter=startDate%20ge%20%222019-05-01T19%3A00%3A00Z%22%20and%20samplingPeriod%20eq%20%2210%22&limit=10&order=-startDate"
        }
    },
    "_embedded": {
        "activityIdentityCounts": [
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-07T15%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-07T21%3A15%3A08.044Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 8491,
                "cumulative": 242784,
                "startDate": "2019-05-07T15:00:00Z",
                "endDate": "2019-05-07T21:15:08.044Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-07T05%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-07T15%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 0,
                "cumulative": 234293,
                "startDate": "2019-05-07T05:00:00Z",
                "endDate": "2019-05-07T15:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-06T19%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-07T05%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 0,
                "cumulative": 234293,
                "startDate": "2019-05-06T19:00:00Z",
                "endDate": "2019-05-07T05:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-06T09%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-06T19%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 14597,
                "cumulative": 234293,
                "startDate": "2019-05-06T09:00:00Z",
                "endDate": "2019-05-06T19:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-05T23%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-06T09%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 19933,
                "cumulative": 219696,
                "startDate": "2019-05-05T23:00:00Z",
                "endDate": "2019-05-06T09:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-05T13%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-05T23%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 20022,
                "cumulative": 199764,
                "startDate": "2019-05-05T13:00:00Z",
                "endDate": "2019-05-05T23:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-05T03%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-05T13%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 19986,
                "cumulative": 179743,
                "startDate": "2019-05-05T03:00:00Z",
                "endDate": "2019-05-05T13:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-04T17%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-05T03%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 20076,
                "cumulative": 159757,
                "startDate": "2019-05-04T17:00:00Z",
                "endDate": "2019-05-05T03:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-04T07%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-04T17%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 20010,
                "cumulative": 139682,
                "startDate": "2019-05-04T07:00:00Z",
                "endDate": "2019-05-04T17:00:00Z"
            },
            {
                "_links": {
                    "activities": {
                        "href": "https://api-staging.pingone.com/v1/environments/a1e118bb-33fd-4e5a-a35a-33fa1c262933/activities?filter=recordedat%20gt%20%222019-05-03T21%3A00%3A00Z%22%20AND%20recordedat%20lt%20%222019-05-04T07%3A00%3A00Z%22%20AND%20%28action.type%20eq%20%22SESSION.UPDATED%22%20OR%20action.type%20eq%20%22SESSION.CREATED%22%20OR%20action.type%20eq%20%22PASSWORD.CHECK_SUCCEEDED%22%29"
                    }
                },
                "value": 20052,
                "cumulative": 119672,
                "startDate": "2019-05-03T21:00:00Z",
                "endDate": "2019-05-04T07:00:00Z"
            }
        ]
    },
    "count": 15,
    "size": 10
}