Read Authentications Per Application (Partial)
GET {{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100
When the endDate in the response is determined to overlap the current date, the partial attribute shows that the response represents a shorter duration than requested by the samplePeriod and samplePeriodCount. This sample request shows the partial attribute in the response.
Filtering data
These SCIM operators can be applied to the following query parameters:
ge(greater than or equal to)
Supported attributes: occurredAt
Note: These SCIM operators are not supported: eq (equal to), 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), and (logical AND), or (logical OR), not (logical NOT).
The following query parameter value ranges are allowed in the request:
| Parameter | Value range |
|---|---|
filter | occuredAt ge "<Date in ISO 8601 format>" |
samplePeriod | [1-8760] |
samplePeriodCount | [1-1000] |
limit | [1-1000] |
In addition, the following product,
samplePeriod * samplePeriodCount * limit
must be less than or equal to 100,000. If one query parameter limitation is violated, the service returns an error with HTTP status code 400.
| Property | Type | Required? | Description |
|---|---|---|---|
id | String | Required | The application ID. |
authentication.startDate | Date | Required | The start date and time of the authentication period. |
authentication.endDate | Date | Required | The end date and time of the authentication period. |
authentication.signons | Integer | Required | The number of authentications for this application during the specified period. |
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
filter | string | ||
limit | number | ||
samplePeriod | number | ||
samplePeriodCount | number |
RESPONSES
status: OK
{"_links":{"self":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22\u0026limit=1\u0026samplePeriod=1\u0026samplePeriodCount=100"},"next":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applicationSignons?cursor=ewogICJvY2N1cnJlZEF0IiA6ICIyMDE5LTEwLTAzVDAwOjAwOjAwWiIsCiAgInNhbXBsZVBlcmlvZCIgOiAxLAogICJzYW1wbGVQZXJpb2RDb3VudCIgOiAxMDAsCiAgImxpbWl0IiA6IDEsCiAgInRva2VuIiA6ICIwMDFlMDAxMDAwMTIwMDEwMTA5NWY0MmEyYTcxNDU5MGE4MzM2OWY1MTEyZDk1Y2VmMDdmZmZmZmZlZjA3ZmZmZmZmZWQ5NGUxYjM1Y2MyMWI1YjQzYWIxODhmODIzOTNkMjhmMDAwNCIsCiAgImNvdW50IiA6IDE0Cn0%3D"}},"_embedded":{"applications":[{"id":"1095f42a-2a71-4590-a833-69f5112d95ce","authentications":[{"startDate":"2019-10-03T04:00:00Z","endDate":"2019-10-03T04:59:59Z","signons":211},{"startDate":"2019-10-03T05:00:00Z","endDate":"2019-10-03T05:59:59Z","signons":54},{"startDate":"2019-10-03T06:00:00Z","endDate":"2019-10-03T06:59:59Z","signons":34},{"startDate":"2019-10-03T07:00:00Z","endDate":"2019-10-03T07:59:59Z","signons":68},{"startDate":"2019-10-03T08:00:00Z","endDate":"2019-10-03T08:59:59Z","signons":87},{"startDate":"2019-10-03T09:00:00Z","endDate":"2019-10-03T09:59:59Z","signons":71},{"startDate":"2019-10-03T10:00:00Z","endDate":"2019-10-03T10:59:59Z","signons":66},{"startDate":"2019-10-03T11:00:00Z","endDate":"2019-10-03T11:59:59Z","signons":96},{"startDate":"2019-10-03T12:00:00Z","endDate":"2019-10-03T12:59:59Z","signons":39},{"startDate":"2019-10-03T13:00:00Z","endDate":"2019-10-03T13:59:59Z","signons":88},{"startDate":"2019-10-03T14:00:00Z","endDate":"2019-10-03T14:59:59Z","signons":57},{"startDate":"2019-10-03T15:00:00Z","endDate":"2019-10-03T15:59:59Z","signons":79},{"startDate":"2019-10-03T16:00:00Z","endDate":"2019-10-03T16:59:59Z","signons":99},{"startDate":"2019-10-03T17:00:00Z","endDate":"2019-10-03T17:16:40Z","signons":55,"partial":true}]}]},"count":14,"size":1}