PingOne Platform APIs

Propagation Plans

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 Type Required? Mutable? Description

environment.id

String

N/A

Read-only

Unique identifier (UUID) of the PingOne environment associated with this propagation plan

id

String

N/A

Read-only

Unique identifier (UUID) of the propagation plan

name

String

Required

Mutable

Unique name of the propagation plan

status

String

Optional

Mutable

Status of the propagation plan; defaults to INACTIVE

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.