PingOne Platform APIs

Read All MFA User Devices

GET {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices

The GET {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices operation returns a list of all device resources associated with the specified user.

If a device is inactive, the status property is set to ACTIVATION_REQUIRED and the _links property includes the activate link. The response shows data for an inactive device.

If devices are ordered, GET {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices returns the devices in their current order, with the default device listed first. If devices are not ordered, the device list returned by GET {{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices does not reflect any order. For more information, refer to Setting device order.

The results from this operation can be filtered and expanded. For more information, refer to Filtering result data and Expanding result data.

Query parameters
Query parameter Attributes (or allowed limits)

expand

accessingDevices, order, typeDisplayNames

filter

* status (eq)

* type (eq)

limit

N/A

order]

N/A

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices")
{
  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}}/v1/environments/{{envID}}/users/{{userID}}/devices"
  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 /v1/environments/{{envID}}/users/{{userID}}/devices 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}}/v1/environments/{{envID}}/users/{{userID}}/devices")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices",
  "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}}/v1/environments/{{envID}}/users/{{userID}}/devices',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/v1/environments/{{envID}}/users/{{userID}}/devices"

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}}/v1/environments/{{envID}}/users/{{userID}}/devices');
$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}}/v1/environments/{{envID}}/users/{{userID}}/devices")

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}}/v1/environments/{{envID}}/users/{{userID}}/devices")!,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.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices"
        },
        "devices.reorder": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices"
        }
    },
    "_embedded": {
        "devices": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/e112c96d-d165-45c5-8061-87ff268fd520"
                    },
                    "environment": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26"
                    }
                },
                "id": "e112c96d-d165-45c5-8061-87ff268fd520",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "b30ac647-e33e-464f-a6ea-0275082d4c26"
                },
                "type": "SMS",
                "lock": {
                    "status": "UNLOCKED"
                },
                "block": {
                    "status": "UNBLOCKED"
                },
                "status": "ACTIVE",
                "createdAt": "2024-03-13T16:27:40.614Z",
                "updatedAt": "2024-03-13T16:27:40.614Z",
                "phone": "+972.547339044"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/cd44c285-2375-4c17-9c54-47dea4438e11"
                    },
                    "environment": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26"
                    }
                },
                "id": "cd44c285-2375-4c17-9c54-47dea4438e11",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "b30ac647-e33e-464f-a6ea-0275082d4c26"
                },
                "type": "WHATSAPP",
                "lock": {
                    "status": "UNLOCKED"
                },
                "block": {
                    "status": "UNBLOCKED"
                },
                "status": "ACTIVE",
                "createdAt": "2024-11-21T11:20:18.259Z",
                "updatedAt": "2024-11-21T11:20:18.259Z",
                "phone": "+1.5125551234"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/f44fa23e-67db-493a-8278-570010dc57f0"
                    },
                    "environment": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26"
                    }
                },
                "id": "f44fa23e-67db-493a-8278-570010dc57f0",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "b30ac647-e33e-464f-a6ea-0275082d4c26"
                },
                "type": "FIDO2",
                "lock": {
                    "status": "UNLOCKED"
                },
                "block": {
                    "status": "UNBLOCKED"
                },
                "status": "ACTIVE",
                "attributes": {
                    "transports": [
                        "hybrid",
                        "internal"
                    ],
                    "isCrossPlatform": false,
                    "isResidentKey": true
                },
                "createdAt": "2025-03-12T15:28:02.384Z",
                "updatedAt": "2025-03-12T15:28:39.719Z",
                "rp": {
                    "id": "pingone.eu",
                    "name": "pingone.eu"
                },
                "backup": {
                    "backupEligibility": true,
                    "backupState": true
                },
                "fidoDeviceMetadata": {
                    "mdsIdentifier": "ea9b8d66-4d01-1d21-3ce4-b6b48cb575d4"
                },
                "displayName": "testAPILabelDisplayName"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/0d26cb0d-a938-46ca-986f-d55aa9bb12c6"
                    },
                    "environment": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26"
                    },
                    "device.activate": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/0d26cb0d-a938-46ca-986f-d55aa9bb12c6"
                    }
                },
                "id": "0d26cb0d-a938-46ca-986f-d55aa9bb12c6",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "b30ac647-e33e-464f-a6ea-0275082d4c26"
                },
                "type": "FIDO2",
                "lock": {
                    "status": "UNLOCKED"
                },
                "block": {
                    "status": "UNBLOCKED"
                },
                "status": "ACTIVATION_REQUIRED",
                "createdAt": "2025-03-06T15:15:04.907Z",
                "updatedAt": "2025-03-06T15:15:04.907Z",
                "rp": {
                    "id": "pingone.com",
                    "name": "PingOne"
                },
                "displayName": "testAPILabelDisplayName"
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/44e3c0b5-fda7-4f48-86ec-457184437cd3"
                    },
                    "environment": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "user": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26"
                    },
                    "device.activate": {
                        "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/44e3c0b5-fda7-4f48-86ec-457184437cd3"
                    }
                },
                "id": "44e3c0b5-fda7-4f48-86ec-457184437cd3",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "user": {
                    "id": "b30ac647-e33e-464f-a6ea-0275082d4c26"
                },
                "type": "TOTP",
                "lock": {
                    "status": "UNLOCKED"
                },
                "block": {
                    "status": "UNBLOCKED"
                },
                "status": "ACTIVATION_REQUIRED",
                "createdAt": "2024-09-01T16:23:09.870Z",
                "updatedAt": "2024-09-01T16:24:40.936Z"
            }
        ]
    },
    "count": 5,
    "size": 5
}