Identity propagation rule entities represent a unidirectional provisioning relationship between a subset of identities on a source identity store and a target identity store. Rules contain attribute mappings, which must be added manually. The PingOne API does not include the default attribute mappings defined by each identity store automatically.

The examples that follow show common actions to find and manage identity propagation rule resources. You need the Environment Admin role to perform operations on identity propagation rule entities.

Propagation rule data model

Property Description
active A boolean that specifies whether this rule is active.
environment.id A string that specifies the environment resource’s unique identifier associated with the resource.
id A string that specifies the resource’s unique identifier.
name A string that specifies the name of the propagation rule. This is a required property.
plan.id A string that specifies the plan ID associated with this rule. This is a required property.
populations.id An array that specifies the list of population IDs to which this rule applies. This is a required property.
sourceStore.id A string that specifies the ID of the source store to which this rule applies. This is a required property.
targetStore.id A string that specifies the ID of the target store to which this rule applies. This is a required property.
deprovision A boolean indicating whether or not to enable deprovisioning of users for a store when it’s deleted. The deprovisioning occurs when a new revision is created (POST {{apiPath}}/environments/{{envID}}/propagation/revisions).

Propagation rule mappings data model

Property Description
environment.id A string that specifies the environment resource’s unique identifier associated with the resource.
id A string that specifies the resource’s unique identifier.
sourceAttribute A string that specifies the source attribute for the rule mapping. This is a required property.
targetAttribute A string that specifies the target attribute for the rule mapping. This is a required property.

Response codes

Code Message
200 Successful operation.
201 Successfully created.
204 Successfully removed. No content.
400 The request could not be completed.
401 You do not have access to this resource.
404 The requested resource was not found.