Read One Device Authentication Policy

GET {{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}

The GET {{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}} operation returns the specified device authentication policy for the environment.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}")
{
  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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}"
  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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}} 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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}",
  "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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}',
  '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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}"

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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}');
$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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}")

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}}/deviceAuthenticationPolicies/{{deviceAuthenticationPolicyID}}")!,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/deviceAuthenticationPolicies/8bec1d08-c0fb-4d34-b472-2610199704c7"
        },
        "environment": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "notificationsPolicy": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsPolicies/162ff6b3-43d1-4cde-86ae-425d22048b2e"
        },
        "applications": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/8bec1d08-c0fb-4d34-b472-2610199704c7/applications"
        },
        "fido2": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/fido2Policies/8401cfde-1d39-4c7c-b886-d861614929e9"
        }
    },
    "id": "8bec1d08-c0fb-4d34-b472-2610199704c7",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "deviceAuthPolicy__1741177336",
    "authentication": {
        "deviceSelection": "DEFAULT_TO_FIRST"
    },
    "notificationsPolicy": {
        "id": "162ff6b3-43d1-4cde-86ae-425d22048b2e"
    },
    "newDeviceNotification": "SMS_THEN_EMAIL",
    "sms": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 0,
                    "timeUnit": "MINUTES"
                }
            },
            "lifeTime": {
                "duration": 30,
                "timeUnit": "MINUTES"
            },
            "otpLength": 6
        }
    },
    "email": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 0,
                    "timeUnit": "MINUTES"
                }
            },
            "lifeTime": {
                "duration": 30,
                "timeUnit": "MINUTES"
            },
            "otpLength": 8
        }
    },
    "mobile": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 2,
                    "timeUnit": "MINUTES"
                }
            }
        },
        "applications": [
            {
                "id": "28e07e36-63d2-46d3-8743-dbdd51c58ee0",
                "push": {
                    "enabled": true
                },
                "otp": {
                    "enabled": true
                },
                "autoEnrollment": {
                    "enabled": true
                },
                "deviceAuthorization": {
                    "enabled": true,
                    "extraVerification": "permissive"
                },
                "pushTimeout": {
                    "duration": 120,
                    "timeUnit": "SECONDS"
                },
                "pairingKeyLifetime": {
                    "duration": 24,
                    "timeUnit": "HOURS"
                },
                "pushLimit": {
                    "count": 4,
                    "timePeriod": {
                        "duration": 20,
                        "timeUnit": "MINUTES"
                    },
                    "lockDuration": {
                        "duration": 30,
                        "timeUnit": "MINUTES"
                    }
                },
                "integrityDetection": "permissive"
            }
        ]
    },
    "totp": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 2,
                    "timeUnit": "MINUTES"
                }
            }
        },
        "uriParameters": {
            "issuer": "Corporate spreadsheet app"
        }
    },
    "voice": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 0,
                    "timeUnit": "MINUTES"
                }
            },
            "lifeTime": {
                "duration": 30,
                "timeUnit": "MINUTES"
            },
            "otpLength": 6
        }
    },
    "fido2": {
        "enabled": true,
        "promptForNicknameOnPairing": true,
        "failure": {
            "count": 4,
            "coolDown": {
                "duration": 150,
                "timeUnit": "SECONDS"
            }
        }
    },
    "rememberMe": {
        "web": {
            "enabled": false,
            "lifeTime": {
                "duration": 30,
                "timeUnit": "DAYS"
            }
        }
    },
    "forSignOnPolicy": false,
    "updatedAt": "2025-03-05T12:22:16.162Z",
    "createdAt": "2025-03-05T12:22:16.162Z",
    "default": false
}

Example Response

200 OK

{
    "_links": {
        "self": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/8bec1d08-c0fb-4d34-b472-2610199704c7"
        },
        "environment": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "notificationsPolicy": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsPolicies/162ff6b3-43d1-4cde-86ae-425d22048b2e"
        },
        "applications": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/8bec1d08-c0fb-4d34-b472-2610199704c7/applications"
        },
        "fido2": {
            "href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/fido2Policies/8401cfde-1d39-4c7c-b886-d861614929e9"
        }
    },
    "id": "8bec1d08-c0fb-4d34-b472-2610199704c7",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "name": "deviceAuthPolicy__1741177336",
    "authentication": {
        "deviceSelection": "DEFAULT_TO_FIRST"
    },
    "notificationsPolicy": {
        "id": "162ff6b3-43d1-4cde-86ae-425d22048b2e"
    },
    "newDeviceNotification": "SMS_THEN_EMAIL",
    "sms": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 0,
                    "timeUnit": "MINUTES"
                }
            },
            "lifeTime": {
                "duration": 30,
                "timeUnit": "MINUTES"
            },
            "otpLength": 6
        }
    },
    "email": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 0,
                    "timeUnit": "MINUTES"
                }
            },
            "lifeTime": {
                "duration": 30,
                "timeUnit": "MINUTES"
            },
            "otpLength": 8
        }
    },
    "mobile": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 2,
                    "timeUnit": "MINUTES"
                }
            }
        },
        "applications": [
            {
                "id": "28e07e36-63d2-46d3-8743-dbdd51c58ee0",
                "push": {
                    "enabled": true
                },
                "otp": {
                    "enabled": true
                },
                "autoEnrollment": {
                    "enabled": true
                },
                "deviceAuthorization": {
                    "enabled": true,
                    "extraVerification": "permissive"
                },
                "pushTimeout": {
                    "duration": 120,
                    "timeUnit": "SECONDS"
                },
                "pairingKeyLifetime": {
                    "duration": 24,
                    "timeUnit": "HOURS"
                },
                "pushLimit": {
                    "count": 4,
                    "timePeriod": {
                        "duration": 20,
                        "timeUnit": "MINUTES"
                    },
                    "lockDuration": {
                        "duration": 30,
                        "timeUnit": "MINUTES"
                    }
                },
                "integrityDetection": "permissive"
            }
        ]
    },
    "totp": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 2,
                    "timeUnit": "MINUTES"
                }
            }
        },
        "uriParameters": {
            "issuer": "Corporate spreadsheet app"
        }
    },
    "voice": {
        "enabled": true,
        "otp": {
            "failure": {
                "count": 3,
                "coolDown": {
                    "duration": 0,
                    "timeUnit": "MINUTES"
                }
            },
            "lifeTime": {
                "duration": 30,
                "timeUnit": "MINUTES"
            },
            "otpLength": 6
        }
    },
    "fido2": {
        "enabled": true,
        "promptForNicknameOnPairing": true,
        "failure": {
            "count": 4,
            "coolDown": {
                "duration": 150,
                "timeUnit": "SECONDS"
            }
        }
    },
    "rememberMe": {
        "web": {
            "enabled": false,
            "lifeTime": {
                "duration": 30,
                "timeUnit": "DAYS"
            }
        }
    },
    "forSignOnPolicy": false,
    "updatedAt": "2025-03-05T12:22:16.162Z",
    "createdAt": "2025-03-05T12:22:16.162Z",
    "default": false
}