Set Device Order
POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/devices
The operation POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/devices with required header Content-type: application/vnd.pingidentity.devices.reorder+json explicitly orders a user’s active devices according to the request body. The device listed first becomes the default device.
After you set the device order, subsequently activated devices are appended to the end of the order list. You can reorder devices with this operation as many times as needed.
For more information, refer to Setting device order.
Prerequisites
-
Refer to MFA Devices for important overview information.
Request Model
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Optional |
|
Date |
Optional |
|
String |
Optional |
|
Date |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
Refer to the Device properties data model for full property descriptions.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices' \
--header 'Content-Type: application/vnd.pingidentity.devices.reorder+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.devices.reorder+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""order"": [" + "\n" +
@" {" + "\n" +
@" ""id"": ""{{deviceID}}""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""{{deviceID_2}}""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""{{deviceID_3}}""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""{{deviceID_4}}""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""id"": ""{{deviceID_5}}""" + "\n" +
@" }" + "\n" +
@" ]" + "\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}}/users/{{userID}}/devices"
method := "POST"
payload := strings.NewReader(`{
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/vnd.pingidentity.devices.reorder+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}}/users/{{userID}}/devices HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.devices.reorder+json
Authorization: Bearer {{accessToken}}
{
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.devices.reorder+json");
RequestBody body = RequestBody.create(mediaType, "{\n \"order\": [\n {\n \"id\": \"{{deviceID}}\"\n },\n {\n \"id\": \"{{deviceID_2}}\"\n },\n {\n \"id\": \"{{deviceID_3}}\"\n },\n {\n \"id\": \"{{deviceID_4}}\"\n },\n {\n \"id\": \"{{deviceID_5}}\"\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")
.method("POST", body)
.addHeader("Content-Type", "application/vnd.pingidentity.devices.reorder+json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/vnd.pingidentity.devices.reorder+json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices',
'headers': {
'Content-Type': 'application/vnd.pingidentity.devices.reorder+json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices"
payload = json.dumps({
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
})
headers = {
'Content-Type': 'application/vnd.pingidentity.devices.reorder+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}}/users/{{userID}}/devices');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/vnd.pingidentity.devices.reorder+json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "order": [\n {\n "id": "{{deviceID}}"\n },\n {\n "id": "{{deviceID_2}}"\n },\n {\n "id": "{{deviceID_3}}"\n },\n {\n "id": "{{deviceID_4}}"\n },\n {\n "id": "{{deviceID_5}}"\n }\n ]\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}}/users/{{userID}}/devices")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.devices.reorder+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"order": [
{
"id": "{{deviceID}}"
},
{
"id": "{{deviceID_2}}"
},
{
"id": "{{deviceID_3}}"
},
{
"id": "{{deviceID_4}}"
},
{
"id": "{{deviceID_5}}"
}
]
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"order\": [\n {\n \"id\": \"{{deviceID}}\"\n },\n {\n \"id\": \"{{deviceID_2}}\"\n },\n {\n \"id\": \"{{deviceID_3}}\"\n },\n {\n \"id\": \"{{deviceID_4}}\"\n },\n {\n \"id\": \"{{deviceID_5}}\"\n }\n ]\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.devices.reorder+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
200 OK
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices"
},
"devices.reorder": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices"
}
},
"_embedded": {
"devices": [
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/eaae1190-b42f-427c-bf92-d5fa5fd9c288"
},
"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/8376797d-641c-4e7b-8bc1-2fdf71916cab"
}
},
"id": "eaae1190-b42f-427c-bf92-d5fa5fd9c288",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"id": "8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"type": "SMS",
"status": "ACTIVE",
"createdAt": "2020-10-30T19:42:02.562Z",
"updatedAt": "2020-10-30T19:42:02.562Z",
"phone": "15127881501"
},
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/b45713b4-1fbf-45b4-9fbf-54c32d63f0d6"
},
"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/8376797d-641c-4e7b-8bc1-2fdf71916cab"
}
},
"id": "b45713b4-1fbf-45b4-9fbf-54c32d63f0d6",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"id": "8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"type": "EMAIL",
"status": "ACTIVE",
"createdAt": "2020-10-30T19:39:25.180Z",
"updatedAt": "2020-10-30T19:39:25.180Z",
"email": "johnbudz@pingidentity.com"
},
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/09859da1-aed0-4be0-af1d-5583471b5d9c"
},
"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/8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"device.activate": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/09859da1-aed0-4be0-af1d-5583471b5d9c"
}
},
"id": "09859da1-aed0-4be0-af1d-5583471b5d9c",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"id": "8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"type": "SECURITY_KEY",
"status": "ACTIVATION_REQUIRED",
"createdAt": "2020-10-29T19:30:08.768Z",
"updatedAt": "2020-10-29T19:30:08.768Z",
"rp": {
"id": "pingone.com"
}
},
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/3aee5588-db8f-4664-a637-97fbff757b81"
},
"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/8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"device.activate": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/3aee5588-db8f-4664-a637-97fbff757b81"
}
},
"id": "3aee5588-db8f-4664-a637-97fbff757b81",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"id": "8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"type": "PLATFORM",
"status": "ACTIVATION_REQUIRED",
"createdAt": "2020-10-29T19:16:38.559Z",
"updatedAt": "2020-10-29T19:16:38.559Z",
"rp": {
"id": "pingone.com"
},
"platform": "BIOMETRICS"
},
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/ef1a087f-45b8-4003-9bdd-a19d5b7723fa"
},
"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/8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"device.activate": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/8376797d-641c-4e7b-8bc1-2fdf71916cab/devices/ef1a087f-45b8-4003-9bdd-a19d5b7723fa"
}
},
"id": "ef1a087f-45b8-4003-9bdd-a19d5b7723fa",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"id": "8376797d-641c-4e7b-8bc1-2fdf71916cab"
},
"type": "PLATFORM",
"status": "ACTIVATION_REQUIRED",
"createdAt": "2020-10-29T19:07:25.907Z",
"updatedAt": "2020-10-29T19:07:25.907Z",
"rp": {
"id": "pingone.com"
},
"platform": "BIOMETRICS"
}
]
},
"count": 5,
"size": 5
}