Create Device Authentication Policy (with Remember Me enabled)
POST {{apiPath}}/environments/{{envID}}/deviceAuthenticationPoliciesThis example uses a POST {{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies request to create a new MFA policy, and includes the rememberMe object to specify that the MFA policy allows users to skip the MFA step on remembered devices if you have implemented a "remember me" option using the PingOne API.
|
To create new MFA policies, you must have a license that includes MFA. |
Prerequisites
-
Refer to Device Authentication Policies for important overview information.
-
Use Read All Applications to retrieve a list of all applications associated with the specified environment and select the specific
appIDfor the body. For more information, refer to Application Management, specifically Application Operations. -
Use Read All FIDO Policies to retrieve all the FIDO policies for an environment and select the specific
fidoPolicyIDfor the body. For more information, refer to FIDO Policies.
Request Model
| Property | Type | Required? |
|---|---|---|
|
Boolean |
Required |
|
Object |
Required |
|
Object |
Optional |
|
Boolean |
Optional |
|
Object |
Required |
|
String |
Required |
|
Optional |
Required |
|
Object |
Optional |
|
Object |
Optional |
|
Boolean |
Optional |
|
Object |
Optional |
|
String |
Optional |
|
Integer |
Optional |
|
Object |
Required |
|
Object |
Required |
|
Object |
Required |
Refer to the Device authentication policy data model for full property descriptions.
Body
raw ( application/json )
{
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe":{
"web":{
"enabled":true,
"lifeTime":{
"timeUnit":"DAYS",
"duration":60
}
}
},
"default": false
}Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe":{
"web":{
"enabled":true,
"lifeTime":{
"timeUnit":"DAYS",
"duration":60
}
}
},
"default": false
}'var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies")
{
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" +
@" ""name"": ""deviceAuthPolicy__{{$timestamp}}""," + "\n" +
@" ""sms"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""otp"": {" + "\n" +
@" ""failure"": {" + "\n" +
@" ""count"": 3," + "\n" +
@" ""coolDown"": {" + "\n" +
@" ""duration"": 0," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""lifeTime"": {" + "\n" +
@" ""duration"": 30," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }," + "\n" +
@" ""otpLength"":6" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""email"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""otp"": {" + "\n" +
@" ""failure"": {" + "\n" +
@" ""count"": 3," + "\n" +
@" ""coolDown"": {" + "\n" +
@" ""duration"": 0," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""lifeTime"": {" + "\n" +
@" ""duration"": 30," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }," + "\n" +
@" ""otpLength"": 8" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""mobile"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""otp"": {" + "\n" +
@" ""failure"": {" + "\n" +
@" ""count"": 3," + "\n" +
@" ""coolDown"": {" + "\n" +
@" ""duration"": 2," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""window"": {" + "\n" +
@" ""stepSize"": {" + "\n" +
@" ""duration"": 30," + "\n" +
@" ""timeUnit"": ""SECONDS""" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""applications"": [" + "\n" +
@" {" + "\n" +
@" ""id"": ""{{appID}}""," + "\n" +
@" ""push"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""otp"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""pushTimeout"": {" + "\n" +
@" ""duration"": 120," + "\n" +
@" ""timeUnit"": ""SECONDS""" + "\n" +
@" }," + "\n" +
@" ""pushLimit"": {" + "\n" +
@" ""count"": 4," + "\n" +
@" ""timePeriod"": {" + "\n" +
@" ""duration"": 20," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }," + "\n" +
@" ""lockDuration"": {" + "\n" +
@" ""duration"": 30," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""pairingKeyLifetime"": {" + "\n" +
@" ""duration"": 24," + "\n" +
@" ""timeUnit"": ""HOURS""" + "\n" +
@" }," + "\n" +
@" ""deviceAuthorization"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""extraVerification"": ""permissive""" + "\n" +
@" }," + "\n" +
@" ""autoEnrollment"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""integrityDetection"": ""permissive""" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@" }," + "\n" +
@" ""totp"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""otp"": {" + "\n" +
@" ""failure"": {" + "\n" +
@" ""count"": 3," + "\n" +
@" ""coolDown"": {" + "\n" +
@" ""duration"": 2," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""uriParameters"": {" + "\n" +
@" ""issuer"": ""Corporate spreadsheet app""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""voice"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""otp"": {" + "\n" +
@" ""failure"": {" + "\n" +
@" ""count"": 3," + "\n" +
@" ""coolDown"": {" + "\n" +
@" ""duration"": 0," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""lifeTime"": {" + "\n" +
@" ""duration"": 30," + "\n" +
@" ""timeUnit"": ""MINUTES""" + "\n" +
@" }," + "\n" +
@" ""otpLength"": 6" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""newDeviceNotification"": ""SMS_THEN_EMAIL""," + "\n" +
@" ""forSignOnPolicy"": false," + "\n" +
@" ""fido2"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""promptForNicknameOnPairing"": true" + "\n" +
@" }," + "\n" +
@" ""rememberMe"":{" + "\n" +
@" ""web"":{" + "\n" +
@" ""enabled"":true," + "\n" +
@" ""lifeTime"":{" + "\n" +
@" ""timeUnit"":""DAYS""," + "\n" +
@" ""duration"":60" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""default"": false" + "\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}}/deviceAuthenticationPolicies"
method := "POST"
payload := strings.NewReader(`{
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe":{
"web":{
"enabled":true,
"lifeTime":{
"timeUnit":"DAYS",
"duration":60
}
}
},
"default": false
}`)
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}}/deviceAuthenticationPolicies HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe":{
"web":{
"enabled":true,
"lifeTime":{
"timeUnit":"DAYS",
"duration":60
}
}
},
"default": false
}OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"deviceAuthPolicy__{{$timestamp}}\",\n \"sms\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 0,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"lifeTime\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n },\n \"otpLength\":6\n }\n },\n \"email\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 0,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"lifeTime\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n },\n \"otpLength\": 8\n }\n },\n \"mobile\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 2,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"window\": {\n \"stepSize\": {\n \"duration\": 30,\n \"timeUnit\": \"SECONDS\"\n }\n }\n },\n \"applications\": [\n {\n \"id\": \"{{appID}}\",\n \"push\": {\n \"enabled\": true\n },\n \"otp\": {\n \"enabled\": true\n },\n \"pushTimeout\": {\n \"duration\": 120,\n \"timeUnit\": \"SECONDS\"\n },\n \"pushLimit\": {\n \"count\": 4,\n \"timePeriod\": {\n \"duration\": 20,\n \"timeUnit\": \"MINUTES\"\n },\n \"lockDuration\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"pairingKeyLifetime\": {\n \"duration\": 24,\n \"timeUnit\": \"HOURS\"\n },\n \"deviceAuthorization\": {\n \"enabled\": true,\n \"extraVerification\": \"permissive\"\n },\n \"autoEnrollment\": {\n \"enabled\": true\n },\n \"integrityDetection\": \"permissive\"\n }\n ]\n },\n \"totp\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 2,\n \"timeUnit\": \"MINUTES\"\n }\n }\n },\n \"uriParameters\": {\n \"issuer\": \"Corporate spreadsheet app\"\n }\n },\n \"voice\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 0,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"lifeTime\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n },\n \"otpLength\": 6\n }\n },\n \"newDeviceNotification\": \"SMS_THEN_EMAIL\",\n \"forSignOnPolicy\": false,\n \"fido2\": {\n \"enabled\": true,\n \"promptForNicknameOnPairing\": true\n },\n \"rememberMe\":{\n \"web\":{\n \"enabled\":true,\n \"lifeTime\":{\n \"timeUnit\":\"DAYS\",\n \"duration\":60\n }\n }\n },\n \"default\": false\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies")
.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}}/deviceAuthenticationPolicies",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe": {
"web": {
"enabled": true,
"lifeTime": {
"timeUnit": "DAYS",
"duration": 60
}
}
},
"default": false
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe": {
"web": {
"enabled": true,
"lifeTime": {
"timeUnit": "DAYS",
"duration": 60
}
}
},
"default": false
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});import requests
import json
url = "{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies"
payload = json.dumps({
"name": "deviceAuthPolicy__{{$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": True
},
"otp": {
"enabled": True
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": True,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": True
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": False,
"fido2": {
"enabled": True,
"promptForNicknameOnPairing": True
},
"rememberMe": {
"web": {
"enabled": True,
"lifeTime": {
"timeUnit": "DAYS",
"duration": 60
}
}
},
"default": False
})
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}}/deviceAuthenticationPolicies');
$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 "name": "deviceAuthPolicy__{{$timestamp}}",\n "sms": {\n "enabled": true,\n "otp": {\n "failure": {\n "count": 3,\n "coolDown": {\n "duration": 0,\n "timeUnit": "MINUTES"\n }\n },\n "lifeTime": {\n "duration": 30,\n "timeUnit": "MINUTES"\n },\n "otpLength":6\n }\n },\n "email": {\n "enabled": true,\n "otp": {\n "failure": {\n "count": 3,\n "coolDown": {\n "duration": 0,\n "timeUnit": "MINUTES"\n }\n },\n "lifeTime": {\n "duration": 30,\n "timeUnit": "MINUTES"\n },\n "otpLength": 8\n }\n },\n "mobile": {\n "enabled": true,\n "otp": {\n "failure": {\n "count": 3,\n "coolDown": {\n "duration": 2,\n "timeUnit": "MINUTES"\n }\n },\n "window": {\n "stepSize": {\n "duration": 30,\n "timeUnit": "SECONDS"\n }\n }\n },\n "applications": [\n {\n "id": "{{appID}}",\n "push": {\n "enabled": true\n },\n "otp": {\n "enabled": true\n },\n "pushTimeout": {\n "duration": 120,\n "timeUnit": "SECONDS"\n },\n "pushLimit": {\n "count": 4,\n "timePeriod": {\n "duration": 20,\n "timeUnit": "MINUTES"\n },\n "lockDuration": {\n "duration": 30,\n "timeUnit": "MINUTES"\n }\n },\n "pairingKeyLifetime": {\n "duration": 24,\n "timeUnit": "HOURS"\n },\n "deviceAuthorization": {\n "enabled": true,\n "extraVerification": "permissive"\n },\n "autoEnrollment": {\n "enabled": true\n },\n "integrityDetection": "permissive"\n }\n ]\n },\n "totp": {\n "enabled": true,\n "otp": {\n "failure": {\n "count": 3,\n "coolDown": {\n "duration": 2,\n "timeUnit": "MINUTES"\n }\n }\n },\n "uriParameters": {\n "issuer": "Corporate spreadsheet app"\n }\n },\n "voice": {\n "enabled": true,\n "otp": {\n "failure": {\n "count": 3,\n "coolDown": {\n "duration": 0,\n "timeUnit": "MINUTES"\n }\n },\n "lifeTime": {\n "duration": 30,\n "timeUnit": "MINUTES"\n },\n "otpLength": 6\n }\n },\n "newDeviceNotification": "SMS_THEN_EMAIL",\n "forSignOnPolicy": false,\n "fido2": {\n "enabled": true,\n "promptForNicknameOnPairing": true\n },\n "rememberMe":{\n "web":{\n "enabled":true,\n "lifeTime":{\n "timeUnit":"DAYS",\n "duration":60\n }\n }\n },\n "default": false\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}}/deviceAuthenticationPolicies")
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({
"name": "deviceAuthPolicy__{{\$timestamp}}",
"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"
}
},
"window": {
"stepSize": {
"duration": 30,
"timeUnit": "SECONDS"
}
}
},
"applications": [
{
"id": "{{appID}}",
"push": {
"enabled": true
},
"otp": {
"enabled": true
},
"pushTimeout": {
"duration": 120,
"timeUnit": "SECONDS"
},
"pushLimit": {
"count": 4,
"timePeriod": {
"duration": 20,
"timeUnit": "MINUTES"
},
"lockDuration": {
"duration": 30,
"timeUnit": "MINUTES"
}
},
"pairingKeyLifetime": {
"duration": 24,
"timeUnit": "HOURS"
},
"deviceAuthorization": {
"enabled": true,
"extraVerification": "permissive"
},
"autoEnrollment": {
"enabled": true
},
"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
}
},
"newDeviceNotification": "SMS_THEN_EMAIL",
"forSignOnPolicy": false,
"fido2": {
"enabled": true,
"promptForNicknameOnPairing": true
},
"rememberMe": {
"web": {
"enabled": true,
"lifeTime": {
"timeUnit": "DAYS",
"duration": 60
}
}
},
"default": false
})
response = http.request(request)
puts response.read_bodylet parameters = "{\n \"name\": \"deviceAuthPolicy__{{$timestamp}}\",\n \"sms\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 0,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"lifeTime\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n },\n \"otpLength\":6\n }\n },\n \"email\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 0,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"lifeTime\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n },\n \"otpLength\": 8\n }\n },\n \"mobile\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 2,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"window\": {\n \"stepSize\": {\n \"duration\": 30,\n \"timeUnit\": \"SECONDS\"\n }\n }\n },\n \"applications\": [\n {\n \"id\": \"{{appID}}\",\n \"push\": {\n \"enabled\": true\n },\n \"otp\": {\n \"enabled\": true\n },\n \"pushTimeout\": {\n \"duration\": 120,\n \"timeUnit\": \"SECONDS\"\n },\n \"pushLimit\": {\n \"count\": 4,\n \"timePeriod\": {\n \"duration\": 20,\n \"timeUnit\": \"MINUTES\"\n },\n \"lockDuration\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"pairingKeyLifetime\": {\n \"duration\": 24,\n \"timeUnit\": \"HOURS\"\n },\n \"deviceAuthorization\": {\n \"enabled\": true,\n \"extraVerification\": \"permissive\"\n },\n \"autoEnrollment\": {\n \"enabled\": true\n },\n \"integrityDetection\": \"permissive\"\n }\n ]\n },\n \"totp\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 2,\n \"timeUnit\": \"MINUTES\"\n }\n }\n },\n \"uriParameters\": {\n \"issuer\": \"Corporate spreadsheet app\"\n }\n },\n \"voice\": {\n \"enabled\": true,\n \"otp\": {\n \"failure\": {\n \"count\": 3,\n \"coolDown\": {\n \"duration\": 0,\n \"timeUnit\": \"MINUTES\"\n }\n },\n \"lifeTime\": {\n \"duration\": 30,\n \"timeUnit\": \"MINUTES\"\n },\n \"otpLength\": 6\n }\n },\n \"newDeviceNotification\": \"SMS_THEN_EMAIL\",\n \"forSignOnPolicy\": false,\n \"fido2\": {\n \"enabled\": true,\n \"promptForNicknameOnPairing\": true\n },\n \"rememberMe\":{\n \"web\":{\n \"enabled\":true,\n \"lifeTime\":{\n \"timeUnit\":\"DAYS\",\n \"duration\":60\n }\n }\n },\n \"default\": false\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/deviceAuthenticationPolicies")!,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
201 Created
{
"_links": {
"self": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/deviceAuthenticationPolicies/15d0474a-9271-489f-9eb6-de48f3284d47"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"fido2": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/fido2Policies/8401cfde-1d39-4c7c-b886-d861614929e9"
}
},
"id": "15d0474a-9271-489f-9eb6-de48f3284d47",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"name": "deviceAuthPolicy__1738511919",
"authentication": {
"deviceSelection": "DEFAULT_TO_FIRST"
},
"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
},
"rememberMe": {
"web": {
"enabled": true,
"lifeTime": {
"duration": 60,
"timeUnit": "DAYS"
}
}
},
"forSignOnPolicy": false,
"updatedAt": "2025-02-02T15:58:40.516Z",
"createdAt": "2025-02-02T15:58:40.516Z",
"default": false
}