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.

Propagation plan errors

In addition to the general error codes, propagation plan operations can return the following errors:

HTTP status Top‑level code Detail code When it happens and what the response contains

400

INVALID_DATA

NotEmpty

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST request omits the required name property

Details: must not be empty for the failing name property

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A POST request attempts to create a plan in an environment that already contains one

Details: environment contains an existing plan with target environment

400

INVALID_DATA

INVALID_VALUE

Message: The request could not be completed. One or more validation errors were in the request.

When and details

When: A DELETE request targets a plan that still has associated rules

Details: plan has associated rules with target id

403

ACCESS_FAILED

None

Message: The actor attempting to perform the request is not authorized.

When and details

When: The actor lacks the osmosis:read:plan permission (the GET operations), the osmosis:update:plan permission (the POST and PUT operations), or the osmosis:delete:plan permission (the DELETE operation)

Details: None.

404

NOT_FOUND

None

Message: Resource not found: {environmentId=<envID>, id=<planID>}

When and details

When: A GET, PUT, or DELETE request references a plan ID that does not exist in the environment

Details: None.