Propagation mappings


Identity 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.

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 rule API operations

The propagation mapping endpoints support the following operations:

For hands-on experience with the propagation mappings API endpoints, click the Run in Postman button below to download a Postman collection that you can import and open in your local Postman application.

Propagation 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.
name A string that specifies the name of the propagation rule. This is a required property.
sourceAttribute A string that specifies the source attribute for the mapping. This is a required property.
targetAttribute A string that specifies the target attribute for the mapping. This is a required property.

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.

Endpoint examples

Get one propagation mapping

To get data for a single propagation mapping resource, the GET /environments/{environmentId}/propagation/mappings/{mappingId} operation returns data for the identity propagation mapping resource with the specified ID.

curl -X GET "https://api.pingone.com/v1/environments/{environmentId}/propagation/mappings/{mappingId}" \
-H "Authorization: Bearer jwtToken"

The response data looks like this:

{
  "id": "1fe0ec15-77a0-44a4-af34-3b9b66a69285",
  "environment": {
    "id": "0d73e3ae-c424-42fd-ad71-9a1c79e90d06"
  },
  "rule": {
    "id": "86b88c9c-613d-4cdd-a0af-71d0dfba0c2f"
  },
  "sourceAttribute": "username",
  "targetAttribute": "userName",
  "_links": {
    "get": {
      "href": "https://api.pingone.com/v1/environments/0d73e3ae-c424-42fd-ad71-9a1c79e90d06/propagation/mappings/1fe0ec15-77a0-44a4-af34-3b9b66a69285"
    },
    "create": {
      "href": "https://api.pingone.com/v1/environments/0d73e3ae-c424-42fd-ad71-9a1c79e90d06/propagation/rules/86b88c9c-613d-4cdd-a0af-71d0dfba0c2f/mappings"
    },
    "update": {
      "href": "https://api.pingone.com/v1/environments/0d73e3ae-c424-42fd-ad71-9a1c79e90d06/propagation/mappings/1fe0ec15-77a0-44a4-af34-3b9b66a69285"
    },
    "delete": {
      "href": "https://api.pingone.com/v1/environments/0d73e3ae-c424-42fd-ad71-9a1c79e90d06/propagation/mappings/1fe0ec15-77a0-44a4-af34-3b9b66a69285"
    }
  }
}

Update propagation mappings

The PUT /environments/{environmentId}/propagation/mappings/{mappingId} operation updates the property values of the identified identity propagation mapping resource.

curl -X "PUT" "https://api.pingone.com/v1/environments/{environmentId}/propagation/mappings/{mappingId}" \
-H 'Content-type: application/json' \
-H 'Authorization: Bearer jwtToken' \
-d '{
    "rule": {
    	"id": "8c9cc5b2-4171-4804-abd4-115a8948e453"
    },
    "sourceAttribute": "username",
    "targetAttribute": "accountId"
}'

Delete propagation mappings

The following sample shows the DELETE /environments/{environmentId}/propagation/mappings/{mappingId} operation to delete the identity propagation mapping resource specified by its ID in the request URL.

curl -X DELETE "https://api.pingone.com/v1/environments/{environmentId}/propagation/mappings/{mappingId}" \
-H "Authorization: Bearer jwtToken"

When successful, the DELETE request returns a code 204 No Content message.