Step 9: Create a sign-on policy action
POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions
Associate a sign-on policy action of type IDENTIFIER_FIRST with the new sign-on policy that you created in the previous step. The POST {{apiPath}}/environments/{{destinationEnvID}}/signOnPolicies/{{policyID}}/actions request creates the sign-on policy action resource.
-
Set
{{policyID}}to the sign-on policy you created in the previous step. -
Enabling
registrationis optional, but recommended. To enable registration, you must include thepopIDfor the destination environment population into which users will be placed.
Body
raw ( application/json )
{
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions")
{
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" +
@" ""type"": ""IDENTIFIER_FIRST""," + "\n" +
@" ""condition"": {" + "\n" +
@" ""greater"": 600," + "\n" +
@" ""secondsSince"": ""${session.lastSignOn.withAuthenticator.pwd.at}""" + "\n" +
@" }," + "\n" +
@" ""priority"": 10," + "\n" +
@" ""recovery"": {" + "\n" +
@" ""enabled"": false" + "\n" +
@" }," + "\n" +
@" ""registration"": {" + "\n" +
@" ""enabled"": true," + "\n" +
@" ""population"": {" + "\n" +
@" ""id"": ""{{popID}}""" + "\n" +
@" }" + "\n" +
@" }," + "\n" +
@" ""socialProviders"": [" + "\n" +
@" {" + "\n" +
@" ""id"": ""{{samlIdpID}}""" + "\n" +
@" }" + "\n" +
@" ]" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions"
method := "POST"
payload := strings.NewReader(`{
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
}`)
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}}/signOnPolicies/{{samlSignonPolicyID}}/actions HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"type\": \"IDENTIFIER_FIRST\",\n \"condition\": {\n \"greater\": 600,\n \"secondsSince\": \"${session.lastSignOn.withAuthenticator.pwd.at}\"\n },\n \"priority\": 10,\n \"recovery\": {\n \"enabled\": false\n },\n \"registration\": {\n \"enabled\": true,\n \"population\": {\n \"id\": \"{{popID}}\"\n }\n },\n \"socialProviders\": [\n {\n \"id\": \"{{samlIdpID}}\"\n }\n ]\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions")
.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}}/signOnPolicies/{{samlSignonPolicyID}}/actions",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions"
payload = json.dumps({
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": False
},
"registration": {
"enabled": True,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
})
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}}/signOnPolicies/{{samlSignonPolicyID}}/actions');
$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 "type": "IDENTIFIER_FIRST",\n "condition": {\n "greater": 600,\n "secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}"\n },\n "priority": 10,\n "recovery": {\n "enabled": false\n },\n "registration": {\n "enabled": true,\n "population": {\n "id": "{{popID}}"\n }\n },\n "socialProviders": [\n {\n "id": "{{samlIdpID}}"\n }\n ]\n}');
try {
$response = $request->send();
if ($response->getStatus() == 200) {
echo $response->getBody();
}
else {
echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
$response->getReasonPhrase();
}
}
catch(HTTP_Request2_Exception $e) {
echo 'Error: ' . $e->getMessage();
}
require "uri"
require "json"
require "net/http"
url = URI("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions")
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({
"type": "IDENTIFIER_FIRST",
"condition": {
"greater": 600,
"secondsSince": "\${session.lastSignOn.withAuthenticator.pwd.at}"
},
"priority": 10,
"recovery": {
"enabled": false
},
"registration": {
"enabled": true,
"population": {
"id": "{{popID}}"
}
},
"socialProviders": [
{
"id": "{{samlIdpID}}"
}
]
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"type\": \"IDENTIFIER_FIRST\",\n \"condition\": {\n \"greater\": 600,\n \"secondsSince\": \"${session.lastSignOn.withAuthenticator.pwd.at}\"\n },\n \"priority\": 10,\n \"recovery\": {\n \"enabled\": false\n },\n \"registration\": {\n \"enabled\": true,\n \"population\": {\n \"id\": \"{{popID}}\"\n }\n },\n \"socialProviders\": [\n {\n \"id\": \"{{samlIdpID}}\"\n }\n ]\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{samlSignonPolicyID}}/actions")!,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.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies/f5429266-6adc-4b10-a226-66e67a0c4e11/actions/1a5b8fd5-375c-4fbc-bd7e-4037e512de85"
},
"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/f5429266-6adc-4b10-a226-66e67a0c4e11"
}
},
"id": "1a5b8fd5-375c-4fbc-bd7e-4037e512de85",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"type": "IDENTIFIER_FIRST",
"condition": {
"secondsSince": "${session.lastSignOn.withAuthenticator.pwd.at}",
"greater": 600
},
"signOnPolicy": {
"id": "f5429266-6adc-4b10-a226-66e67a0c4e11"
},
"priority": 10,
"registration": {
"enabled": true,
"population": {
"id": "60971d3b-cc5a-4601-9c44-2be541f91bf1"
}
},
"recovery": {
"enabled": false
}
}