PingOne Platform APIs

Create report of MFA-enabled devices - results in file

POST {{apiPath}}/environments/{{envID}}/dataExplorations

This example uses the dataExplorations endpoint to create a report of all MFA-enabled devices.

In the body of the request, deliverAs is set to ASYNC_FILE so that the results will be provided as a file.

The dataExplorationTemplateID has a static value of db632bfd-7054-4bde-b108-a384aac2d513.

Request Model

Refer to Reporting for more information, including the complete data model.

MFA reports data model

Property Type Required?

dataExplorationTemplate.id

String

Required

deliverAs

String

Optional

fields[]

Array

Optional

filter

String

Optional

sync

String

Optional

The response contains a status field. The value of this field will be IN_PROGRESS until the generation of the report has been completed.

After running this request, poll with the request GET {{apiPath}}/environments/{{envID}}/dataExplorations/{{dataExplorationID}}, using the ID that was returned when you created the report, until the status field in the response equals SUCCESS.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "dataExplorationTemplate": {
        "id": "{{dataExplorationTemplateID}}"
    },
    "fields": [
        {
            "name": "userId"
        },
        {
            "name": "username"
        },
        {
            "name": "phone"
        },
        {
            "name": "deviceStatus"
        },
        {
            "name": "deviceId"
        }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "deliverAs":"ASYNC_FILE"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/dataExplorations' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "dataExplorationTemplate": {
        "id": "{{dataExplorationTemplateID}}"
    },
    "fields": [
        {
            "name": "userId"
        },
        {
            "name": "username"
        },
        {
            "name": "phone"
        },
        {
            "name": "deviceStatus"
        },
        {
            "name": "deviceId"
        }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "deliverAs":"ASYNC_FILE"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/dataExplorations")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""dataExplorationTemplate"": {" + "\n" +
@"        ""id"": ""{{dataExplorationTemplateID}}""" + "\n" +
@"    }," + "\n" +
@"    ""fields"": [" + "\n" +
@"        { " + "\n" +
@"            ""name"": ""userId""" + "\n" +
@"        }," + "\n" +
@"        { " + "\n" +
@"            ""name"": ""username""" + "\n" +
@"        }," + "\n" +
@"        { " + "\n" +
@"            ""name"": ""phone""" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""name"": ""deviceStatus""" + "\n" +
@"        }," + "\n" +
@"        {" + "\n" +
@"            ""name"": ""deviceId""" + "\n" +
@"        }" + "\n" +
@"    ]," + "\n" +
@"    ""filter"": ""(mfaEnabled eq \""true\"")"",    " + "\n" +
@"    ""deliverAs"":""ASYNC_FILE""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/environments/{{envID}}/dataExplorations"
  method := "POST"

  payload := strings.NewReader(`{
    "dataExplorationTemplate": {
        "id": "{{dataExplorationTemplateID}}"
    },
    "fields": [
        {
            "name": "userId"
        },
        {
            "name": "username"
        },
        {
            "name": "phone"
        },
        {
            "name": "deviceStatus"
        },
        {
            "name": "deviceId"
        }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "deliverAs":"ASYNC_FILE"
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  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))
}
POST /environments/{{envID}}/dataExplorations HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "dataExplorationTemplate": {
        "id": "{{dataExplorationTemplateID}}"
    },
    "fields": [
        {
            "name": "userId"
        },
        {
            "name": "username"
        },
        {
            "name": "phone"
        },
        {
            "name": "deviceStatus"
        },
        {
            "name": "deviceId"
        }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "deliverAs":"ASYNC_FILE"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"dataExplorationTemplate\": {\n        \"id\": \"{{dataExplorationTemplateID}}\"\n    },\n    \"fields\": [\n        { \n            \"name\": \"userId\"\n        },\n        { \n            \"name\": \"username\"\n        },\n        { \n            \"name\": \"phone\"\n        },\n        {\n            \"name\": \"deviceStatus\"\n        },\n        {\n            \"name\": \"deviceId\"\n        }\n    ],\n    \"filter\": \"(mfaEnabled eq \\\"true\\\")\",    \n    \"deliverAs\":\"ASYNC_FILE\"\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/dataExplorations")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/dataExplorations",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "dataExplorationTemplate": {
      "id": "{{dataExplorationTemplateID}}"
    },
    "fields": [
      {
        "name": "userId"
      },
      {
        "name": "username"
      },
      {
        "name": "phone"
      },
      {
        "name": "deviceStatus"
      },
      {
        "name": "deviceId"
      }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "deliverAs": "ASYNC_FILE"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/dataExplorations',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "dataExplorationTemplate": {
      "id": "{{dataExplorationTemplateID}}"
    },
    "fields": [
      {
        "name": "userId"
      },
      {
        "name": "username"
      },
      {
        "name": "phone"
      },
      {
        "name": "deviceStatus"
      },
      {
        "name": "deviceId"
      }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "deliverAs": "ASYNC_FILE"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/dataExplorations"

payload = json.dumps({
  "dataExplorationTemplate": {
    "id": "{{dataExplorationTemplateID}}"
  },
  "fields": [
    {
      "name": "userId"
    },
    {
      "name": "username"
    },
    {
      "name": "phone"
    },
    {
      "name": "deviceStatus"
    },
    {
      "name": "deviceId"
    }
  ],
  "filter": "(mfaEnabled eq \"true\")",
  "deliverAs": "ASYNC_FILE"
})
headers = {
  'Content-Type': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/dataExplorations');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "dataExplorationTemplate": {\n        "id": "{{dataExplorationTemplateID}}"\n    },\n    "fields": [\n        { \n            "name": "userId"\n        },\n        { \n            "name": "username"\n        },\n        { \n            "name": "phone"\n        },\n        {\n            "name": "deviceStatus"\n        },\n        {\n            "name": "deviceId"\n        }\n    ],\n    "filter": "(mfaEnabled eq \\"true\\")",    \n    "deliverAs":"ASYNC_FILE"\n}');
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 "json"
require "net/http"

url = URI("{{apiPath}}/environments/{{envID}}/dataExplorations")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "dataExplorationTemplate": {
    "id": "{{dataExplorationTemplateID}}"
  },
  "fields": [
    {
      "name": "userId"
    },
    {
      "name": "username"
    },
    {
      "name": "phone"
    },
    {
      "name": "deviceStatus"
    },
    {
      "name": "deviceId"
    }
  ],
  "filter": "(mfaEnabled eq \"true\")",
  "deliverAs": "ASYNC_FILE"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"dataExplorationTemplate\": {\n        \"id\": \"{{dataExplorationTemplateID}}\"\n    },\n    \"fields\": [\n        { \n            \"name\": \"userId\"\n        },\n        { \n            \"name\": \"username\"\n        },\n        { \n            \"name\": \"phone\"\n        },\n        {\n            \"name\": \"deviceStatus\"\n        },\n        {\n            \"name\": \"deviceId\"\n        }\n    ],\n    \"filter\": \"(mfaEnabled eq \\\"true\\\")\",    \n    \"deliverAs\":\"ASYNC_FILE\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/dataExplorations")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

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

202 Accepted

{
    "_links": {
        "self": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorations/0fe52654-ff7a-4c90-8d80-1af1a745c097"
        },
        "environment": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "dataExplorationTemplate": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/dataExplorationTemplates/db632bfd-7054-4bde-b108-a384aac2d513"
        }
    },
    "id": "0fe52654-ff7a-4c90-8d80-1af1a745c097",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "createdAt": "2023-10-16T11:51:26.000Z",
    "updatedAt": "2023-10-16T11:51:26.000Z",
    "expiresAt": "2023-10-16T12:21:26.000Z",
    "fields": [
        {
            "name": "userId"
        },
        {
            "name": "username"
        },
        {
            "name": "phone"
        },
        {
            "name": "deviceStatus"
        },
        {
            "name": "deviceId"
        }
    ],
    "filter": "(mfaEnabled eq \"true\")",
    "orderBy": [],
    "status": "IN_PROGRESS",
    "deliverAs": "ASYNC_FILE",
    "sync": false,
    "dataExplorationTemplate": {
        "id": "db632bfd-7054-4bde-b108-a384aac2d513",
        "name": "Devices report"
    }
}