PingOne Platform APIs

Read One Session

GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/sessions/{{sessionID}}

The GET {{apiPath}}/environments/{{envID}}/users/{{userID}}/sessions/{{sessionID}} operation returns a single session for the specified user and environment.

The session information returned includes session location, date, browser, operating system, and device information.

Role information

A user having the Identity Data Administrator role assigned at the Population level can read sessions for any users in the assigned populations. They cannot read sessions for users outside of those populations, even if the users are in the same environment.

A user having the Identity Data Administrator role assigned at the Environment level can read the sessions of any user in any population in that environment.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/sessions/{{sessionID}}' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/sessions/{{sessionID}}")
{
  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}}/users/{{userID}}/sessions/{{sessionID}}"
  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}}/users/{{userID}}/sessions/{{sessionID}} 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}}/users/{{userID}}/sessions/{{sessionID}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/sessions/{{sessionID}}",
  "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}}/users/{{userID}}/sessions/{{sessionID}}',
  '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}}/users/{{userID}}/sessions/{{sessionID}}"

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}}/users/{{userID}}/sessions/{{sessionID}}');
$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}}/users/{{userID}}/sessions/{{sessionID}}")

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}}/users/{{userID}}/sessions/{{sessionID}}")!,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/users/710d6278-ccce-4a91-bdb9-ac7a4a0e60d5/sessions"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "user": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/710d6278-ccce-4a91-bdb9-ac7a4a0e60d5"
        }
    },
    "id": "465b7031-292f-4641-941f-e21240a88a43",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "user": {
        "id": "710d6278-ccce-4a91-bdb9-ac7a4a0e60d5"
    },
    "createdAt": "2022-09-20T16:00:57.382Z",
    "activeAt": "2022-10-11T16:59:42.302Z",
    "idleTimeoutInMinutes": 43200,
    "userAgent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Safari/537.36",
    "browser": {
        "name": "Chrome",
        "version": "106.0.0"
    },
    "operatingSystem": {
        "name": "Mac OS X",
        "version": "10.15.7"
    },
    "device": {
        "type": "Mac"
    },
    "locations": [
        {
            "at": "2022-10-06T16:27:55.647Z",
            "remoteIp": "65.152.119.108",
            "city": "henderson",
            "state": "colorado",
            "region": "mountain",
            "country": "united states"
        },
        {
            "at": "2022-10-06T18:54:55.623Z",
            "remoteIp": "65.152.119.108",
            "city": "henderson",
            "state": "colorado",
            "region": "mountain",
            "country": "united states"
        },
        {
            "at": "2022-10-11T16:44:00.402Z",
            "remoteIp": "65.152.119.108",
            "city": "henderson",
            "state": "colorado",
            "region": "mountain",
            "country": "united states"
        },
        {
            "at": "2022-10-11T16:52:37.473Z",
            "remoteIp": "65.152.119.108",
            "city": "henderson",
            "state": "colorado",
            "region": "mountain",
            "country": "united states"
        },
        {
            "at": "2022-10-11T16:59:42.302Z",
            "remoteIp": "65.152.119.108",
            "city": "henderson",
            "state": "colorado",
            "region": "mountain",
            "country": "united states"
        }
    ],
    "lastSignOn": {
        "remoteIp": "65.152.119.108",
        "authenticators": [
            "pwd"
        ],
        "withAuthenticator": {
            "pwd": {
                "policy": {
                    "id": "6b7fbe27-15e7-4b89-a176-5c35ae30855f",
                    "type": "PINGONE"
                },
                "at": "2022-10-11T16:44:00.401Z"
            }
        },
        "policy": {
            "id": "6b7fbe27-15e7-4b89-a176-5c35ae30855f",
            "type": "PINGONE"
        },
        "at": "2022-10-11T16:44:00.401Z"
    },
    "expiresAt": "2022-11-10T16:59:42.302Z"
}