Update Sign-On Policy Action
PUT {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}
The PUT {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}} operation updates the sign-on policy action resource specified by its ID in the request URL.
Prerequisites
-
Create a sign-on policy to get a
policyIDfor the endpoint.
Request Model
| Property | Type | Required? |
|---|---|---|
|
Integer |
Required |
Refer to the Sign-on policy actions base data model for full property descriptions.
Body
raw ( application/json )
{
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": false
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff --request PUT '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-raw '{
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": false
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}")
{
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" +
@" ""priority"": 2," + "\n" +
@" ""type"": ""PROGRESSIVE_PROFILING""," + "\n" +
@" ""condition"": {" + "\n" +
@" ""or"": [" + "\n" +
@" {" + "\n" +
@" ""not"": {" + "\n" +
@" ""ipRange"": [" + "\n" +
@" ""10.5.3.72/24""" + "\n" +
@" ]," + "\n" +
@" ""contains"": ""${flow.request.http.remoteIp}""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""secondsSince"": ""${session.lastSignOn.withAuthenticator.pwd.at}""," + "\n" +
@" ""greater"": 50400" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${user.population.id}""," + "\n" +
@" ""equals"": ""{{popID}}""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""value"": ""${user.email}""," + "\n" +
@" ""equals"": ""joe@pingidentity.com""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""ipRisk"": {" + "\n" +
@" ""minScore"": 80," + "\n" +
@" ""maxScore"": 100" + "\n" +
@" }," + "\n" +
@" ""valid"": ""${flow.request.http.remoteIp}""" + "\n" +
@" }," + "\n" +
@" {" + "\n" +
@" ""geoVelocity"": ""${flow.request.http.remoteIp}""," + "\n" +
@" ""valid"": {" + "\n" +
@" ""previousSuccessfulAuthenticationTime"": ""${user.lastSignOn.at}""," + "\n" +
@" ""previousSuccessfulAuthenticationIp"": ""${user.lastSignOn.remoteIp}""" + "\n" +
@" }" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@" }," + "\n" +
@" ""promptText"": ""For the best experience, we need a couple things from you.""," + "\n" +
@" ""promptIntervalSeconds"": 3600," + "\n" +
@" ""preventMultiplePromptsPerFlow"": 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}}/signOnPolicies/{{policyID}}/actions/{{actionID}}"
method := "PUT"
payload := strings.NewReader(`{
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": 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))
}
PUT /environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": false
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"priority\": 2,\n \"type\": \"PROGRESSIVE_PROFILING\",\n \"condition\": {\n \"or\": [\n {\n \"not\": {\n \"ipRange\": [\n \"10.5.3.72/24\"\n ],\n \"contains\": \"${flow.request.http.remoteIp}\"\n }\n },\n {\n \"secondsSince\": \"${session.lastSignOn.withAuthenticator.pwd.at}\",\n \"greater\": 50400\n },\n {\n \"value\": \"${user.population.id}\",\n \"equals\": \"{{popID}}\"\n },\n {\n \"value\": \"${user.email}\",\n \"equals\": \"joe@pingidentity.com\"\n },\n {\n \"ipRisk\": {\n \"minScore\": 80,\n \"maxScore\": 100\n },\n \"valid\": \"${flow.request.http.remoteIp}\"\n },\n {\n \"geoVelocity\": \"${flow.request.http.remoteIp}\",\n \"valid\": {\n \"previousSuccessfulAuthenticationTime\": \"${user.lastSignOn.at}\",\n \"previousSuccessfulAuthenticationIp\": \"${user.lastSignOn.remoteIp}\"\n }\n }\n ]\n },\n \"promptText\": \"For the best experience, we need a couple things from you.\",\n \"promptIntervalSeconds\": 3600,\n \"preventMultiplePromptsPerFlow\": false\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}")
.method("PUT", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}",
"method": "PUT",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": false
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'PUT',
'url': '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": false
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}"
payload = json.dumps({
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": False
})
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/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}');
$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 "priority": 2,\n "type": "PROGRESSIVE_PROFILING",\n "condition": {\n "or": [\n {\n "not": {\n "ipRange": [\n "10.5.3.72/24"\n ],\n "contains": "${flow.request.http.remoteIp}"\n }\n },\n {\n "secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",\n "greater": 50400\n },\n {\n "value": "${user.population.id}",\n "equals": "{{popID}}"\n },\n {\n "value": "${user.email}",\n "equals": "joe@pingidentity.com"\n },\n {\n "ipRisk": {\n "minScore": 80,\n "maxScore": 100\n },\n "valid": "${flow.request.http.remoteIp}"\n },\n {\n "geoVelocity": "${flow.request.http.remoteIp}",\n "valid": {\n "previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",\n "previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"\n }\n }\n ]\n },\n "promptText": "For the best experience, we need a couple things from you.",\n "promptIntervalSeconds": 3600,\n "preventMultiplePromptsPerFlow": 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}}/signOnPolicies/{{policyID}}/actions/{{actionID}}")
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({
"priority": 2,
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "\${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "\${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "\${user.population.id}",
"equals": "{{popID}}"
},
{
"value": "\${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "\${flow.request.http.remoteIp}"
},
{
"geoVelocity": "\${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "\${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "\${user.lastSignOn.remoteIp}"
}
}
]
},
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600,
"preventMultiplePromptsPerFlow": false
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"priority\": 2,\n \"type\": \"PROGRESSIVE_PROFILING\",\n \"condition\": {\n \"or\": [\n {\n \"not\": {\n \"ipRange\": [\n \"10.5.3.72/24\"\n ],\n \"contains\": \"${flow.request.http.remoteIp}\"\n }\n },\n {\n \"secondsSince\": \"${session.lastSignOn.withAuthenticator.pwd.at}\",\n \"greater\": 50400\n },\n {\n \"value\": \"${user.population.id}\",\n \"equals\": \"{{popID}}\"\n },\n {\n \"value\": \"${user.email}\",\n \"equals\": \"joe@pingidentity.com\"\n },\n {\n \"ipRisk\": {\n \"minScore\": 80,\n \"maxScore\": 100\n },\n \"valid\": \"${flow.request.http.remoteIp}\"\n },\n {\n \"geoVelocity\": \"${flow.request.http.remoteIp}\",\n \"valid\": {\n \"previousSuccessfulAuthenticationTime\": \"${user.lastSignOn.at}\",\n \"previousSuccessfulAuthenticationIp\": \"${user.lastSignOn.remoteIp}\"\n }\n }\n ]\n },\n \"promptText\": \"For the best experience, we need a couple things from you.\",\n \"promptIntervalSeconds\": 3600,\n \"preventMultiplePromptsPerFlow\": false\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions/{{actionID}}")!,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.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/f73594d5-9b2e-45bf-abec-3f629ab53721/actions/3ede2d1f-0006-4206-85f8-8efd2dc4bdb2"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"signOnPolicy": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/f73594d5-9b2e-45bf-abec-3f629ab53721"
}
},
"id": "3ede2d1f-0006-4206-85f8-8efd2dc4bdb2",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"type": "PROGRESSIVE_PROFILING",
"condition": {
"or": [
{
"not": {
"ipRange": [
"10.5.3.72/24"
],
"contains": "${flow.request.http.remoteIp}"
}
},
{
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 50400
},
{
"value": "${user.population.id}",
"equals": "cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"
},
{
"value": "${user.email}",
"equals": "joe@pingidentity.com"
},
{
"ipRisk": {
"minScore": 80,
"maxScore": 100
},
"valid": "${flow.request.http.remoteIp}"
},
{
"geoVelocity": "${flow.request.http.remoteIp}",
"valid": {
"previousSuccessfulAuthenticationTime": "${user.lastSignOn.at}",
"previousSuccessfulAuthenticationIp": "${user.lastSignOn.remoteIp}"
}
}
]
},
"signOnPolicy": {
"id": "f73594d5-9b2e-45bf-abec-3f629ab53721"
},
"priority": 2,
"preventMultiplePromptsPerFlow": false,
"promptText": "For the best experience, we need a couple things from you.",
"promptIntervalSeconds": 3600
}