PingOne Platform APIs

Propagation Mappings

Identity propagation mapping entities represent the attribute mappings associated with identity propagation rules. A mapping entity identified an attribute in the source identity store that is mapped to an attribute in the target identity store.

To reflect the propagation mappings API changes in the PingOne Admin Console, you must create a new propagation revision.

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

Propagation mapping data model

Property Type Required? Mutable? Description

attributeMappingType

Boolean

Optional

Mutable

Categorizes the attribute mapping as either group or user attribute mapping.

environment.id

String

N/A

Read-only

Identifier (UUID) of the PingOne environment for the propagation mapping

expression

String

Required/Optional

Mutable

PingOne Expression Language (PEL) expression to create the target attribute, such as supply a literal value, reformat the source value, or combine source user attributes. Either expression or sourceAttribute is required but not both. For more information on PEL, refer to PingOne expression language

id

String

N/A

Read-only

Identifier (UUID) of the propagation mapping

name

String

Required

Mutable

Unique name of the propagation mapping

rule.id

String

Required

Immutable

Identifier (UUID) of the rule to which this mapping applies

sourceAttribute

String

Required/Optional

Mutable

Source attribute for the mapping. Either expression or sourceAttribute is required but not both.

targetAttribute

String

Required

Mutable

Target attribute for the mapping

Response codes

Code Message

200

Successful operation.

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.