Create Rule (Writeback)
POST {{apiPath}}/environments/{{envID}}/propagation/plans/{{planID}}/rules
The POST /environments/{{envID}}/propagation/rules operation adds a new propagation rule resource to the specified environment resource. Writeback rules only operate on user records that have been provisioned inbound by the parent rule. Therefore, the population selection properties do not pertain to writeback rules. Available user attributes for any store can be obtained with the appropriate request found in Propagation Store Metadata and looking under userAttributes.
To visualize how a writeback rule is deployed, see the use case Create a Workday propagation connection.
See Propagation rule data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
description | String | Optional |
name | String | Required |
parentRule.id | String | Required |
plan.id | String | Required |
sourceStore.id | String | Required |
targetStore.id | String | Required |
Prerequisites
- Create a propagation plan to get a
planIDfor the endpoint and the body. See also Identity Propagation (Provisioning), especially Propagation Plans. - Create source and target propagation stores to get a
sourceStoreIDandtargetStoreIDfor the body. See also Identity Propagation (Provisioning), especially Propagation Stores. - If using a population identifier in the
populationExpression, or using the deprecatedpopulation.id, Create a population to get apopIDfor the body. See also Populations.
Request Body
{"plan"=>{"id"=>"{{planID}}"}, "environment"=>{"id"=>"{{envID}}"}, "sourceStore"=>{"id"=>"{{writebackStoreID}}"}, "targetStore"=>{"id"=>"{{sourceStoreID}}"}, "name"=>"Workday Writeback Rule", "description"=>"Workday writeback rule description", "parentRule"=>{"id"=>"{{parentRuleID}}"}}
RESPONSES
status: Created
{"id":"12e82a11-26d2-4ca6-b221-0b55fd1200ac","environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"createdAt":"2022-10-11T14:39:43.040Z","updatedAt":"2022-10-11T14:39:43.040Z","plan":{"id":"70a2dd92-da36-449b-bd70-6a5955af1364"},"sourceStore":{"id":"fdad63d8-591c-4cb2-a682-1ce6989ffd88"},"targetStore":{"id":"4e1b141b-ba0c-4922-a592-c86f2f802b35"},"name":"Workday Writeback Rule","description":"Workday writeback rule description","active":false,"deprovision":false,"parentRule":{"id":"a114cb98-ddd5-4d72-961c-632ef41dc35c"},"_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/12e82a11-26d2-4ca6-b221-0b55fd1200ac"},"update":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/12e82a11-26d2-4ca6-b221-0b55fd1200ac"},"delete":{"href":"https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/12e82a11-26d2-4ca6-b221-0b55fd1200ac"}}}