Update Application (PingID App)
PUT {{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}
This example uses PUT {{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}} to update the settings for the PingID application.
When you update the settings, any optional parameters left out result in the clearing of the corresponding settings. To prevent unintentional changes, always run GET {{apiPath}}/environments/{{envID}}/applications/{{pingAppID}} before updating the application settings, and use the response as the basis for the body of the PUT request.
Prerequisites
See Application Operations for important overview information.
Request Model
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
Boolean |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Boolean |
Optional |
|
Date |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
Boolean |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
Array |
Optional |
|
Array |
Optional |
|
Array |
Optional |
|
Array |
Optional |
|
Boolean |
Optional |
|
String |
Required |
|
String |
Required |
|
Integer |
Required |
|
Integer |
Required |
|
String |
Required |
See PingID mobile app configuration data model for complete descriptions.
Body
raw ( application/json )
{
"name": "PingID Mobile",
"description":"The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand":{
"enabled":true,
"deviceBrandsDisAllowed":[
"Apple"
],
"deviceModelsDisAllowed":[
"iPad Mini 3 (WiFi)"]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push":{
"numberMatching":{
"type":"SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled":true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PUT '{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"name": "PingID Mobile",
"description":"The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand":{
"enabled":true,
"deviceBrandsDisAllowed":[
"Apple"
],
"deviceModelsDisAllowed":[
"iPad Mini 3 (WiFi)"]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push":{
"numberMatching":{
"type":"SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled":true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Put);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""name"": ""PingID Mobile""," + "\n" +
@" ""description"":""The PingID mobile application can be used for multi-factor authentication and user verification use cases.""," + "\n" +
@" ""protocol"": ""OPENID_CONNECT""," + "\n" +
@" ""type"": ""NATIVE_APP""," + "\n" +
@" ""enabled"": true," + "\n" +
@" ""refreshTokenDuration"": 2592000," + "\n" +
@" ""refreshTokenRollingDuration"": 15552000," + "\n" +
@" ""mobile"": {" + "\n" +
@" ""pingIDSettings"": true," + "\n" +
@" ""bundleId"": ""com.pingidentity.pingid.prod""," + "\n" +
@" ""packageName"": ""prod.com.pingidentity.pingid""," + "\n" +
@" ""otpPushNotificationEnabled"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""allowUnPairAndChangeDeviceFromApp"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""mobileAppSecurityPinRequire"": {" + "\n" +
@" ""requireForAllDevices"": true," + "\n" +
@" ""securityPinDigit"": ""FOUR_DIGIT""," + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""allowAuthenticationDeviceLocked"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""restrictDevicesByBrand"":{" + "\n" +
@" ""enabled"":true," + "\n" +
@" ""deviceBrandsDisAllowed"":[" + "\n" +
@" ""Apple""" + "\n" +
@" ]," + "\n" +
@" ""deviceModelsDisAllowed"":[" + "\n" +
@" ""iPad Mini 3 (WiFi)""]" + "\n" +
@" }," + "\n" +
@" ""deviceLockEnableRequire"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""deviceRequireBiometricsCapabilities"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""deviceNotAllowedRootedOrJailBroken"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""mobileDeviceManagementRequire"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""effectiveDate"": ""2025-01-13T11:29:11.943Z""," + "\n" +
@" ""tokens"": [" + "\n" +
@" {" + "\n" +
@" ""token"": ""89b2fa74-b6c8-4bd0-9096-611b65917bd0""," + "\n" +
@" ""creationTime"": ""2025-01-13T11:29:18.447Z""" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@" }," + "\n" +
@" ""minimumOSVersionRequire"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""android"": ""8.1""," + "\n" +
@" ""ios"": ""16.6.1""" + "\n" +
@" }," + "\n" +
@" ""showAuthenticationInformation"": {" + "\n" +
@" ""enabled"": true" + "\n" +
@" }," + "\n" +
@" ""push"":{" + "\n" +
@" ""numberMatching"":{" + "\n" +
@" ""type"":""SELECT_NUMBER""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""mobileDeviceBiometricsSetting"": {" + "\n" +
@" ""enabled"": false," + "\n" +
@" ""required"": true," + "\n" +
@" ""faceIdConsentEnabled"": true," + "\n" +
@" ""notificationActionsEnabled"": true," + "\n" +
@" ""devicePasscodeFallbackEnabled"":true" + "\n" +
@" }," + "\n" +
@" ""minimumPingIDAppVersionRequire"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""android"": ""1.32.0""," + "\n" +
@" ""ios"": ""1.33.0""" + "\n" +
@" }," + "\n" +
@" ""notifyRequireMobileVersionUpdates"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""android"": ""1.36.0""," + "\n" +
@" ""ios"": ""1.35.0""" + "\n" +
@" }," + "\n" +
@" ""notifyOptionalMobileVersionUpdates"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""android"": ""1.38.0""," + "\n" +
@" ""ios"": ""latest""" + "\n" +
@" }" + "\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/{{EnvIDConverged}}/applications/{{pingAppID}}"
method := "PUT"
payload := strings.NewReader(`{
"name": "PingID Mobile",
"description":"The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand":{
"enabled":true,
"deviceBrandsDisAllowed":[
"Apple"
],
"deviceModelsDisAllowed":[
"iPad Mini 3 (WiFi)"]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push":{
"numberMatching":{
"type":"SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled":true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
}`)
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))
}
PUT /environments/{{EnvIDConverged}}/applications/{{pingAppID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"name": "PingID Mobile",
"description":"The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand":{
"enabled":true,
"deviceBrandsDisAllowed":[
"Apple"
],
"deviceModelsDisAllowed":[
"iPad Mini 3 (WiFi)"]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push":{
"numberMatching":{
"type":"SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled":true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"name\": \"PingID Mobile\",\n \"description\":\"The PingID mobile application can be used for multi-factor authentication and user verification use cases.\",\n \"protocol\": \"OPENID_CONNECT\",\n \"type\": \"NATIVE_APP\",\n \"enabled\": true,\n \"refreshTokenDuration\": 2592000,\n \"refreshTokenRollingDuration\": 15552000,\n \"mobile\": {\n \"pingIDSettings\": true,\n \"bundleId\": \"com.pingidentity.pingid.prod\",\n \"packageName\": \"prod.com.pingidentity.pingid\",\n \"otpPushNotificationEnabled\": {\n \"enabled\": true\n },\n \"allowUnPairAndChangeDeviceFromApp\": {\n \"enabled\": true\n },\n \"mobileAppSecurityPinRequire\": {\n \"requireForAllDevices\": true,\n \"securityPinDigit\": \"FOUR_DIGIT\",\n \"enabled\": true\n },\n \"allowAuthenticationDeviceLocked\": {\n \"enabled\": true\n },\n \"restrictDevicesByBrand\":{\n \"enabled\":true,\n \"deviceBrandsDisAllowed\":[\n \"Apple\"\n ],\n \"deviceModelsDisAllowed\":[\n \"iPad Mini 3 (WiFi)\"]\n },\n \"deviceLockEnableRequire\": {\n \"enabled\": true\n },\n \"deviceRequireBiometricsCapabilities\": {\n \"enabled\": true\n },\n \"deviceNotAllowedRootedOrJailBroken\": {\n \"enabled\": true\n },\n \"mobileDeviceManagementRequire\": {\n \"enabled\": true,\n \"effectiveDate\": \"2025-01-13T11:29:11.943Z\",\n \"tokens\": [\n {\n \"token\": \"89b2fa74-b6c8-4bd0-9096-611b65917bd0\",\n \"creationTime\": \"2025-01-13T11:29:18.447Z\"\n }\n ]\n },\n \"minimumOSVersionRequire\": {\n \"enabled\": true,\n \"android\": \"8.1\",\n \"ios\": \"16.6.1\"\n },\n \"showAuthenticationInformation\": {\n \"enabled\": true\n },\n \"push\":{\n \"numberMatching\":{\n \"type\":\"SELECT_NUMBER\"\n }\n },\n \"mobileDeviceBiometricsSetting\": {\n \"enabled\": false,\n \"required\": true,\n \"faceIdConsentEnabled\": true,\n \"notificationActionsEnabled\": true,\n \"devicePasscodeFallbackEnabled\":true\n },\n \"minimumPingIDAppVersionRequire\": {\n \"enabled\": true,\n \"android\": \"1.32.0\",\n \"ios\": \"1.33.0\"\n },\n \"notifyRequireMobileVersionUpdates\": {\n \"enabled\": true,\n \"android\": \"1.36.0\",\n \"ios\": \"1.35.0\"\n },\n \"notifyOptionalMobileVersionUpdates\": {\n \"enabled\": true,\n \"android\": \"1.38.0\",\n \"ios\": \"latest\"\n }\n }\n}\n");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}",
"method": "PUT",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"name": "PingID Mobile",
"description": "The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand": {
"enabled": true,
"deviceBrandsDisAllowed": [
"Apple"
],
"deviceModelsDisAllowed": [
"iPad Mini 3 (WiFi)"
]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push": {
"numberMatching": {
"type": "SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled": true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'PUT',
'url': '{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"name": "PingID Mobile",
"description": "The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand": {
"enabled": true,
"deviceBrandsDisAllowed": [
"Apple"
],
"deviceModelsDisAllowed": [
"iPad Mini 3 (WiFi)"
]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push": {
"numberMatching": {
"type": "SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled": true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}"
payload = json.dumps({
"name": "PingID Mobile",
"description": "The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": True,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": True,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": True
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": True
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": True,
"securityPinDigit": "FOUR_DIGIT",
"enabled": True
},
"allowAuthenticationDeviceLocked": {
"enabled": True
},
"restrictDevicesByBrand": {
"enabled": True,
"deviceBrandsDisAllowed": [
"Apple"
],
"deviceModelsDisAllowed": [
"iPad Mini 3 (WiFi)"
]
},
"deviceLockEnableRequire": {
"enabled": True
},
"deviceRequireBiometricsCapabilities": {
"enabled": True
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": True
},
"mobileDeviceManagementRequire": {
"enabled": True,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": True,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": True
},
"push": {
"numberMatching": {
"type": "SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": False,
"required": True,
"faceIdConsentEnabled": True,
"notificationActionsEnabled": True,
"devicePasscodeFallbackEnabled": True
},
"minimumPingIDAppVersionRequire": {
"enabled": True,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": True,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": True,
"android": "1.38.0",
"ios": "latest"
}
}
})
headers = {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("PUT", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}');
$request->setMethod(HTTP_Request2::METHOD_PUT);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "name": "PingID Mobile",\n "description":"The PingID mobile application can be used for multi-factor authentication and user verification use cases.",\n "protocol": "OPENID_CONNECT",\n "type": "NATIVE_APP",\n "enabled": true,\n "refreshTokenDuration": 2592000,\n "refreshTokenRollingDuration": 15552000,\n "mobile": {\n "pingIDSettings": true,\n "bundleId": "com.pingidentity.pingid.prod",\n "packageName": "prod.com.pingidentity.pingid",\n "otpPushNotificationEnabled": {\n "enabled": true\n },\n "allowUnPairAndChangeDeviceFromApp": {\n "enabled": true\n },\n "mobileAppSecurityPinRequire": {\n "requireForAllDevices": true,\n "securityPinDigit": "FOUR_DIGIT",\n "enabled": true\n },\n "allowAuthenticationDeviceLocked": {\n "enabled": true\n },\n "restrictDevicesByBrand":{\n "enabled":true,\n "deviceBrandsDisAllowed":[\n "Apple"\n ],\n "deviceModelsDisAllowed":[\n "iPad Mini 3 (WiFi)"]\n },\n "deviceLockEnableRequire": {\n "enabled": true\n },\n "deviceRequireBiometricsCapabilities": {\n "enabled": true\n },\n "deviceNotAllowedRootedOrJailBroken": {\n "enabled": true\n },\n "mobileDeviceManagementRequire": {\n "enabled": true,\n "effectiveDate": "2025-01-13T11:29:11.943Z",\n "tokens": [\n {\n "token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",\n "creationTime": "2025-01-13T11:29:18.447Z"\n }\n ]\n },\n "minimumOSVersionRequire": {\n "enabled": true,\n "android": "8.1",\n "ios": "16.6.1"\n },\n "showAuthenticationInformation": {\n "enabled": true\n },\n "push":{\n "numberMatching":{\n "type":"SELECT_NUMBER"\n }\n },\n "mobileDeviceBiometricsSetting": {\n "enabled": false,\n "required": true,\n "faceIdConsentEnabled": true,\n "notificationActionsEnabled": true,\n "devicePasscodeFallbackEnabled":true\n },\n "minimumPingIDAppVersionRequire": {\n "enabled": true,\n "android": "1.32.0",\n "ios": "1.33.0"\n },\n "notifyRequireMobileVersionUpdates": {\n "enabled": true,\n "android": "1.36.0",\n "ios": "1.35.0"\n },\n "notifyOptionalMobileVersionUpdates": {\n "enabled": true,\n "android": "1.38.0",\n "ios": "latest"\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/{{EnvIDConverged}}/applications/{{pingAppID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Put.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"name": "PingID Mobile",
"description": "The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"protocol": "OPENID_CONNECT",
"type": "NATIVE_APP",
"enabled": true,
"refreshTokenDuration": 2592000,
"refreshTokenRollingDuration": 15552000,
"mobile": {
"pingIDSettings": true,
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"otpPushNotificationEnabled": {
"enabled": true
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"restrictDevicesByBrand": {
"enabled": true,
"deviceBrandsDisAllowed": [
"Apple"
],
"deviceModelsDisAllowed": [
"iPad Mini 3 (WiFi)"
]
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-01-13T11:29:18.447Z"
}
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"showAuthenticationInformation": {
"enabled": true
},
"push": {
"numberMatching": {
"type": "SELECT_NUMBER"
}
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled": true
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
}
}
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"name\": \"PingID Mobile\",\n \"description\":\"The PingID mobile application can be used for multi-factor authentication and user verification use cases.\",\n \"protocol\": \"OPENID_CONNECT\",\n \"type\": \"NATIVE_APP\",\n \"enabled\": true,\n \"refreshTokenDuration\": 2592000,\n \"refreshTokenRollingDuration\": 15552000,\n \"mobile\": {\n \"pingIDSettings\": true,\n \"bundleId\": \"com.pingidentity.pingid.prod\",\n \"packageName\": \"prod.com.pingidentity.pingid\",\n \"otpPushNotificationEnabled\": {\n \"enabled\": true\n },\n \"allowUnPairAndChangeDeviceFromApp\": {\n \"enabled\": true\n },\n \"mobileAppSecurityPinRequire\": {\n \"requireForAllDevices\": true,\n \"securityPinDigit\": \"FOUR_DIGIT\",\n \"enabled\": true\n },\n \"allowAuthenticationDeviceLocked\": {\n \"enabled\": true\n },\n \"restrictDevicesByBrand\":{\n \"enabled\":true,\n \"deviceBrandsDisAllowed\":[\n \"Apple\"\n ],\n \"deviceModelsDisAllowed\":[\n \"iPad Mini 3 (WiFi)\"]\n },\n \"deviceLockEnableRequire\": {\n \"enabled\": true\n },\n \"deviceRequireBiometricsCapabilities\": {\n \"enabled\": true\n },\n \"deviceNotAllowedRootedOrJailBroken\": {\n \"enabled\": true\n },\n \"mobileDeviceManagementRequire\": {\n \"enabled\": true,\n \"effectiveDate\": \"2025-01-13T11:29:11.943Z\",\n \"tokens\": [\n {\n \"token\": \"89b2fa74-b6c8-4bd0-9096-611b65917bd0\",\n \"creationTime\": \"2025-01-13T11:29:18.447Z\"\n }\n ]\n },\n \"minimumOSVersionRequire\": {\n \"enabled\": true,\n \"android\": \"8.1\",\n \"ios\": \"16.6.1\"\n },\n \"showAuthenticationInformation\": {\n \"enabled\": true\n },\n \"push\":{\n \"numberMatching\":{\n \"type\":\"SELECT_NUMBER\"\n }\n },\n \"mobileDeviceBiometricsSetting\": {\n \"enabled\": false,\n \"required\": true,\n \"faceIdConsentEnabled\": true,\n \"notificationActionsEnabled\": true,\n \"devicePasscodeFallbackEnabled\":true\n },\n \"minimumPingIDAppVersionRequire\": {\n \"enabled\": true,\n \"android\": \"1.32.0\",\n \"ios\": \"1.33.0\"\n },\n \"notifyRequireMobileVersionUpdates\": {\n \"enabled\": true,\n \"android\": \"1.36.0\",\n \"ios\": \"1.35.0\"\n },\n \"notifyOptionalMobileVersionUpdates\": {\n \"enabled\": true,\n \"android\": \"1.38.0\",\n \"ios\": \"latest\"\n }\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{EnvIDConverged}}/applications/{{pingAppID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
request.httpMethod = "PUT"
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.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/1c3a8032-d39d-441d-9c65-0364ad14234f"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"attributes": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/1c3a8032-d39d-441d-9c65-0364ad14234f/attributes"
},
"pushCredentials": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/1c3a8032-d39d-441d-9c65-0364ad14234f/pushCredentials"
},
"secret": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/1c3a8032-d39d-441d-9c65-0364ad14234f/secret"
},
"grants": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/1c3a8032-d39d-441d-9c65-0364ad14234f/grants"
}
},
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"id": "1c3a8032-d39d-441d-9c65-0364ad14234f",
"name": "PingID Mobile",
"description": "The PingID mobile application can be used for multi-factor authentication and user verification use cases.",
"enabled": true,
"type": "NATIVE_APP",
"protocol": "OPENID_CONNECT",
"createdAt": "2025-03-27T15:04:37.586Z",
"updatedAt": "2025-04-08T09:35:05.590Z",
"assignActorRoles": false,
"mobile": {
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"integrityDetection": {
"mode": "DISABLED"
},
"push": {
"numberMatching": {
"type": "SELECT_NUMBER"
}
},
"passcodeRefreshDuration": {
"duration": 30,
"timeUnit": "SECONDS"
},
"allowUnPairAndChangeDeviceFromApp": {
"enabled": true
},
"allowAuthenticationDeviceLocked": {
"enabled": true
},
"mobileAppSecurityPinRequire": {
"requireForAllDevices": true,
"securityPinDigit": "FOUR_DIGIT",
"enabled": true
},
"notifyRequireMobileVersionUpdates": {
"enabled": true,
"android": "1.36.0",
"ios": "1.35.0"
},
"notifyOptionalMobileVersionUpdates": {
"enabled": true,
"android": "1.38.0",
"ios": "latest"
},
"restrictDevicesByBrand": {
"enabled": true,
"deviceModelsDisAllowed": [
"iPad Mini 3 (WiFi)"
],
"deviceBrandsDisAllowed": [
"Apple"
]
},
"minimumOSVersionRequire": {
"enabled": true,
"android": "8.1",
"ios": "16.6.1"
},
"minimumPingIDAppVersionRequire": {
"enabled": true,
"android": "1.32.0",
"ios": "1.33.0"
},
"deviceLockEnableRequire": {
"enabled": true
},
"deviceNotAllowedRootedOrJailBroken": {
"enabled": true
},
"deviceRequireBiometricsCapabilities": {
"enabled": true
},
"mobileDeviceManagementRequire": {
"enabled": true,
"effectiveDate": "2025-01-13T11:29:11.943Z",
"tokens": [
{
"token": "89b2fa74-b6c8-4bd0-9096-611b65917bd0",
"creationTime": "2025-04-01T11:02:31.904Z"
}
]
},
"mobileDeviceBiometricsSetting": {
"enabled": false,
"required": true,
"faceIdConsentEnabled": true,
"notificationActionsEnabled": true,
"devicePasscodeFallbackEnabled": true
},
"showAuthenticationInformation": {
"enabled": true
},
"otpPushNotificationEnabled": {
"enabled": true
},
"pingIDSettings": true
},
"bundleId": "com.pingidentity.pingid.prod",
"packageName": "prod.com.pingidentity.pingid",
"refreshTokenDuration": 2592000,
"p1ApiAccessTokenValiditySeconds": 3600,
"pkceEnforcement": "OPTIONAL",
"tokenEndpointAuthMethod": "NONE",
"refreshTokenRollingDuration": 15552000,
"parRequirement": "OPTIONAL",
"devicePollingInterval": 5,
"parTimeout": 60,
"deviceTimeout": 600
}