Step 7: Create a Workday inbound propagation rule
POST {{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules
Use POST {{apiPath}}/environments/{{envID}}/propagation/rules to add a Workday inbound propagation rule to the specified environment. The property populationExpression is a SCIM filter on any user attribute of the source identity store. For example, you can define a SCIM filter for a Workday inbound rule as: "populationExpression": "supervisoryOrg eq \"Human Resources\"" and the rule will synchronize all users from Workday that have a supervisoryOrg of Human Resources. For this use case, we select users who belong to the population created in Step 2: Create a population to synchronize with Workday. Available user attributes for any store can be obtained with the appropriate request found in Propagation Store Metadata and looking under userAttributes.
Request Model
| Property | Type | Required? |
|---|---|---|
|
String |
Optional |
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Optional |
|
String |
Required |
|
String |
Required |
Body
raw ( application/json )
{
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules")
{
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" +
@" ""plan"": {" + "\n" +
@" ""id"": ""{{wdPlanID}}""" + "\n" +
@" }," + "\n" +
@" ""environment"": {" + "\n" +
@" ""id"": ""{{envID}}""" + "\n" +
@" }," + "\n" +
@" ""sourceStore"": {" + "\n" +
@" ""id"": ""{{wdSourceStoreID}}""" + "\n" +
@" }," + "\n" +
@" ""targetStore"": {" + "\n" +
@" ""id"": ""{{wdTargetStoreID}}""" + "\n" +
@" }," + "\n" +
@" ""deprovision"": true," + "\n" +
@" ""name"": ""Workday Use Case Rule""," + "\n" +
@" ""description"": ""Workday use case rule description""," + "\n" +
@" ""populationExpression"": ""population.id eq \""{{wdPopID}}\""""" + "\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}}/propagation/plans/{{wdPlanID}}/rules"
method := "POST"
payload := strings.NewReader(`{
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
}`)
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}}/propagation/plans/{{wdPlanID}}/rules HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"plan\": {\n \"id\": \"{{wdPlanID}}\"\n },\n \"environment\": {\n \"id\": \"{{envID}}\"\n },\n \"sourceStore\": {\n \"id\": \"{{wdSourceStoreID}}\"\n },\n \"targetStore\": {\n \"id\": \"{{wdTargetStoreID}}\"\n },\n \"deprovision\": true,\n \"name\": \"Workday Use Case Rule\",\n \"description\": \"Workday use case rule description\",\n \"populationExpression\": \"population.id eq \\\"{{wdPopID}}\\\"\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules")
.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}}/propagation/plans/{{wdPlanID}}/rules",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules"
payload = json.dumps({
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": True,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
})
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}}/propagation/plans/{{wdPlanID}}/rules');
$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 "plan": {\n "id": "{{wdPlanID}}"\n },\n "environment": {\n "id": "{{envID}}"\n },\n "sourceStore": {\n "id": "{{wdSourceStoreID}}"\n },\n "targetStore": {\n "id": "{{wdTargetStoreID}}"\n },\n "deprovision": true,\n "name": "Workday Use Case Rule",\n "description": "Workday use case rule description",\n "populationExpression": "population.id eq \\"{{wdPopID}}\\""\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}}/propagation/plans/{{wdPlanID}}/rules")
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({
"plan": {
"id": "{{wdPlanID}}"
},
"environment": {
"id": "{{envID}}"
},
"sourceStore": {
"id": "{{wdSourceStoreID}}"
},
"targetStore": {
"id": "{{wdTargetStoreID}}"
},
"deprovision": true,
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"populationExpression": "population.id eq \"{{wdPopID}}\""
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"plan\": {\n \"id\": \"{{wdPlanID}}\"\n },\n \"environment\": {\n \"id\": \"{{envID}}\"\n },\n \"sourceStore\": {\n \"id\": \"{{wdSourceStoreID}}\"\n },\n \"targetStore\": {\n \"id\": \"{{wdTargetStoreID}}\"\n },\n \"deprovision\": true,\n \"name\": \"Workday Use Case Rule\",\n \"description\": \"Workday use case rule description\",\n \"populationExpression\": \"population.id eq \\\"{{wdPopID}}\\\"\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/propagation/plans/{{wdPlanID}}/rules")!,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
{
"id": "a114cb98-ddd5-4d72-961c-632ef41dc35c",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"createdAt": "2022-10-11T14:39:38.947Z",
"updatedAt": "2022-10-11T14:39:38.947Z",
"plan": {
"id": "70a2dd92-da36-449b-bd70-6a5955af1364"
},
"sourceStore": {
"id": "4e1b141b-ba0c-4922-a592-c86f2f802b35"
},
"targetStore": {
"id": "3bc4587f-e92d-4682-95d3-f66d25d37779"
},
"name": "Workday Use Case Rule",
"description": "Workday use case rule description",
"active": false,
"populationExpression": "population.id eq \"cd053929-8971-42e3-a5e2-9b3dde933ffd\"",
"deprovision": true,
"_links": {
"create": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/70a2dd92-da36-449b-bd70-6a5955af1364/rules"
},
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/a114cb98-ddd5-4d72-961c-632ef41dc35c"
},
"update": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/a114cb98-ddd5-4d72-961c-632ef41dc35c"
},
"delete": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/a114cb98-ddd5-4d72-961c-632ef41dc35c"
}
}
}