Total identities


Total identity counts

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.

Filtering result data

The GET request for total identities requires a SCIM filter to specify start and end dates for the response data. For example, this SCIM filter returns active identity counts divided into time periods of one day from the start date of 2019-01-01 to the end date of 2019-02-01:

https://api.pingone.com/v1/environments/{environmentId}/totalIdentities?filter=startDate eq "2019-01-01T00:00:00+00:00" and endDate eq "2019-02-01T00:00:00+00:00"

These SCIM operators can be applied to the following attributes:

  • eq (equals)

    Supported attributes: startDate and endDate

  • 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), ge (greater than or equal to), 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.

Total identities API operations

The total identities endpoint supports the following operations:

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

Total identities data model

Property Description
date The date and time the total identities count starts for the sampling period (ISO 8601 format).
totalIdentities An integer that specifies the total unique identities count for the sampling period.

Note: The count attribute in the response data shows the current number of unique identities for the environment. For more information, see Response data structure.

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 total identity counts

You can get the total count of unique identities associated with a selected environment for a specified time period (per day). The GET /environments/{environmentId}/totalIdentities request must provide a SCIM filtering expression in the request URL that designates a date range. The following sample specifies a date range from 2019-03-01 through 2019-04-01 (sample size of 32 days).

curl -X GET "https://api.pingone.com/v1/environments/{environmentId}/totalIdentities?filter=startDate%20eq%20%222019-03-01T23%3A00%3A00%2B00%3A00%22%20and%20endDate%20eq%20%222019-04-01T00%3A00%3A00%2B00%3A00%22" \
-H "Authorization: Bearer jwtToken"

The response data looks like this:

{
    "_links": {
        "self": {
            "href": "https://api-staging.pingone.com/v1/environments/fa34cdbb-55b1-4eef-9ee8-a8b9a2f02830/totalIdentities"
        }
    },
    "_embedded": {
        "totalIdentities": [
            {
                "date": "2019-03-01T00:00:00.000Z",
                "totalIdentities": 5
            },
            {
                "date": "2019-03-02T00:00:00.000Z",
                "totalIdentities": 5
            },
            {
                "date": "2019-03-03T00:00:00.000Z",
                "totalIdentities": 5
            },
            {
                "date": "2019-03-04T00:00:00.000Z",
                "totalIdentities": 5
            },
            {
                "date": "2019-03-05T00:00:00.000Z",
                "totalIdentities": 5
            },
            {
                "date": "2019-03-06T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-07T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-08T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-09T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-10T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-11T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-12T00:00:00.000Z",
                "totalIdentities": 4
            },
            {
                "date": "2019-03-13T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-14T00:00:00.000Z",
                "totalIdentities": 5
            },
            {
                "date": "2019-03-15T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-16T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-17T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-18T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-19T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-20T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-21T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-22T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-23T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-24T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-25T00:00:00.000Z",
                "totalIdentities": 6
            },
            {
                "date": "2019-03-26T00:00:00.000Z",
                "totalIdentities": 7
            },
            {
                "date": "2019-03-27T00:00:00.000Z",
                "totalIdentities": 7
            },
            {
                "date": "2019-03-28T00:00:00.000Z",
                "totalIdentities": 8
            },
            {
                "date": "2019-03-29T00:00:00.000Z",
                "totalIdentities": 7
            },
            {
                "date": "2019-03-30T00:00:00.000Z",
                "totalIdentities": 7
            },
            {
                "date": "2019-03-31T00:00:00.000Z",
                "totalIdentities": 7
            },
            {
                "date": "2019-04-01T00:00:00.000Z",
                "totalIdentities": 7
            }
        ]
    },
    "count": 7,
    "size": 32
}