PingOne Platform APIs

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

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).

Query parameters

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 product of the properties, 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.

Request Model
Property Type Required?

id

String

Required

authentication.startDate

Date

Required

authentication.endDate

Date

Required

authentication.signons

Integer

Required

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
GET /environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100 HTTP/1.1
Host: {{apiPath}}
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100"

payload = {}
headers = {
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/applicationSignons?filter=occurredAt%20ge%20%222019-10-03T00%3A00%3A00Z%22&limit=1&samplePeriod=1&samplePeriodCount=100")!,timeoutInterval: Double.infinity)
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 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&limit=1&samplePeriod=1&samplePeriodCount=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
}