Identity propagation plan entities represent a collection of unidirectional provisioning relationships between pairs of identity stores. At this time, a customer can define one plan per environment, owning zero or more rules, which in turn may own zero or more mappings. Deleting a plan instance must also delete all associated rule and mapping instances. A plan is recognized by the provisioning engine when it has an active status and it defines at least one rule.

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

Propagation plan 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.
name A string that specifies the name of the propagation plan. This is a required property.
status A string that specifies the status of the propagation plan.

Propagation plan rules data model

Property Description
active A boolean that specifies whether the propagation plan 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 plan. This is a required property.
plan.id A string that specifies the plan resource’s unique identifier associated with this rule.
plan.id A string that specifies the plan resource’s unique identifier associated with this rule.
poppulations.id An array that specifies the list of population resource identifiers associated with this rule.
targetStore.id A string that specifies the identity target store resource’s unique identifier associated with this rule.
status A string that specifies the status of the propagation plan.

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.