PingOne Platform APIs

Step 4: Create the sign-on policy action with registration enabled

 

POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/actions

The POST {{apiPath}}/environments/{{envID}}/signOnPolicies/{{policyID}}/actions operation creates the new sign-on policy action resource, which is associated with the sign-on policy ({{policyID}}) specified in the request URL.

PingOne supports several sign-on policy action types. In this use case, the type property is set to the LOGIN action type, and it includes the registration property set to true in the request body.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "environment": {
        "id": "{{envID}}"
    },
    "signOnPolicy": {
        "id": "{{registrationPolicyID}}"
    },
    "priority": 10,
    "type": "LOGIN",
    "registration": {
        "enabled": true,
        "population": {
            "id": "{{registrationPopID}}"
        }
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/actions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "environment": {
        "id": "{{envID}}"
    },
    "signOnPolicy": {
        "id": "{{registrationPolicyID}}"
    },
    "priority": 10,
    "type": "LOGIN",
    "registration": {
        "enabled": true,
        "population": {
            "id": "{{registrationPopID}}"
        }
    }
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/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" +
@"    ""environment"": {" + "\n" +
@"        ""id"": ""{{envID}}""" + "\n" +
@"    }," + "\n" +
@"    ""signOnPolicy"": {" + "\n" +
@"        ""id"": ""{{registrationPolicyID}}""" + "\n" +
@"    }," + "\n" +
@"    ""priority"": 10," + "\n" +
@"    ""type"": ""LOGIN""," + "\n" +
@"    ""registration"": {" + "\n" +
@"        ""enabled"": true," + "\n" +
@"        ""population"": {" + "\n" +
@"            ""id"": ""{{registrationPopID}}""" + "\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/{{registrationPolicyID}}/actions"
  method := "POST"

  payload := strings.NewReader(`{
    "environment": {
        "id": "{{envID}}"
    },
    "signOnPolicy": {
        "id": "{{registrationPolicyID}}"
    },
    "priority": 10,
    "type": "LOGIN",
    "registration": {
        "enabled": true,
        "population": {
            "id": "{{registrationPopID}}"
        }
    }
}`)

  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/{{registrationPolicyID}}/actions HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}

{
    "environment": {
        "id": "{{envID}}"
    },
    "signOnPolicy": {
        "id": "{{registrationPolicyID}}"
    },
    "priority": 10,
    "type": "LOGIN",
    "registration": {
        "enabled": true,
        "population": {
            "id": "{{registrationPopID}}"
        }
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"environment\": {\n        \"id\": \"{{envID}}\"\n    },\n    \"signOnPolicy\": {\n        \"id\": \"{{registrationPolicyID}}\"\n    },\n    \"priority\": 10,\n    \"type\": \"LOGIN\",\n    \"registration\": {\n        \"enabled\": true,\n        \"population\": {\n            \"id\": \"{{registrationPopID}}\"\n        }\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/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/{{registrationPolicyID}}/actions",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "environment": {
      "id": "{{envID}}"
    },
    "signOnPolicy": {
      "id": "{{registrationPolicyID}}"
    },
    "priority": 10,
    "type": "LOGIN",
    "registration": {
      "enabled": true,
      "population": {
        "id": "{{registrationPopID}}"
      }
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/actions',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "environment": {
      "id": "{{envID}}"
    },
    "signOnPolicy": {
      "id": "{{registrationPolicyID}}"
    },
    "priority": 10,
    "type": "LOGIN",
    "registration": {
      "enabled": true,
      "population": {
        "id": "{{registrationPopID}}"
      }
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/actions"

payload = json.dumps({
  "environment": {
    "id": "{{envID}}"
  },
  "signOnPolicy": {
    "id": "{{registrationPolicyID}}"
  },
  "priority": 10,
  "type": "LOGIN",
  "registration": {
    "enabled": True,
    "population": {
      "id": "{{registrationPopID}}"
    }
  }
})
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/{{registrationPolicyID}}/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    "environment": {\n        "id": "{{envID}}"\n    },\n    "signOnPolicy": {\n        "id": "{{registrationPolicyID}}"\n    },\n    "priority": 10,\n    "type": "LOGIN",\n    "registration": {\n        "enabled": true,\n        "population": {\n            "id": "{{registrationPopID}}"\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/{{registrationPolicyID}}/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({
  "environment": {
    "id": "{{envID}}"
  },
  "signOnPolicy": {
    "id": "{{registrationPolicyID}}"
  },
  "priority": 10,
  "type": "LOGIN",
  "registration": {
    "enabled": true,
    "population": {
      "id": "{{registrationPopID}}"
    }
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"environment\": {\n        \"id\": \"{{envID}}\"\n    },\n    \"signOnPolicy\": {\n        \"id\": \"{{registrationPolicyID}}\"\n    },\n    \"priority\": 10,\n    \"type\": \"LOGIN\",\n    \"registration\": {\n        \"enabled\": true,\n        \"population\": {\n            \"id\": \"{{registrationPopID}}\"\n        }\n    }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/signOnPolicies/{{registrationPolicyID}}/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/713fd56f-cb7f-4238-8fbe-aaa88a227d3e/actions/8c037aed-c09c-496a-93bd-ee76a90f3de1"
        },
        "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/713fd56f-cb7f-4238-8fbe-aaa88a227d3e"
        }
    },
    "id": "8c037aed-c09c-496a-93bd-ee76a90f3de1",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "type": "LOGIN",
    "signOnPolicy": {
        "id": "713fd56f-cb7f-4238-8fbe-aaa88a227d3e"
    },
    "priority": 10,
    "registration": {
        "enabled": true,
        "population": {
            "id": "f9a5d827-08b6-466a-9876-fae17042f3b1"
        }
    },
    "recovery": {
        "enabled": true
    }
}