PingOne Platform APIs

Read All Rules

 

GET {{apiPath}}/environments/{{envId}}/propagation/rules

The GET {{apiPath}}/environments/{{envId}}/propagation/rules endpoint returns a list of all propagation rule resources associated with the specified environment resource.

Headers

Authorization      Bearer {{accessToken}}

Accept      application/json

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envId}}/propagation/rules' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envId}}/propagation/rules")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
request.AddHeader("Accept", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

import (
  "fmt"
  "net/http"
  "io"
)

func main() {

  url := "{{apiPath}}/environments/{{envId}}/propagation/rules"
  method := "GET"

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, nil)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer {{accessToken}}")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}
GET /environments/{{envId}}/propagation/rules HTTP/1.1
Host: {{apiPath}}
Accept: application/json
Authorization: Bearer {{accessToken}}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("text/plain");
RequestBody body = RequestBody.create(mediaType, "");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envId}}/propagation/rules")
  .method("GET", body)
  .addHeader("Accept", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envId}}/propagation/rules",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Accept": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'GET',
  'url': '{{apiPath}}/environments/{{envId}}/propagation/rules',
  'headers': {
    'Accept': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests

url = "{{apiPath}}/environments/{{envId}}/propagation/rules"

payload = {}
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {{accessToken}}'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envId}}/propagation/rules');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
try {
  $response = $request->send();
  if ($response->getStatus() == 200) {
    echo $response->getBody();
  }
  else {
    echo 'Unexpected HTTP status: ' . $response->getStatus() . ' ' .
    $response->getReasonPhrase();
  }
}
catch(HTTP_Request2_Exception $e) {
  echo 'Error: ' . $e->getMessage();
}
require "uri"
require "net/http"

url = URI("{{apiPath}}/environments/{{envId}}/propagation/rules")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Get.new(url)
request["Accept"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envId}}/propagation/rules")!,timeoutInterval: Double.infinity)
request.addValue("application/json", forHTTPHeaderField: "Accept")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")

request.httpMethod = "GET"

let task = URLSession.shared.dataTask(with: request) { data, response, error in
  guard let data = data else {
    print(String(describing: error))
    return
  }
  print(String(data: data, encoding: .utf8)!)
}

task.resume()

Example Response

200 OK

{
  "_embedded": {
    "rules": [
      {
        "id": "01088dad-f401-4ea8-826f-d40858a686e5",
        "createdAt": "2025-12-18T06:46:44.596Z",
        "updatedAt": "2025-12-23T08:25:47.255Z",
        "plan": {
          "id": "cb009b87-963f-48ea-b92e-f5a12bf083aa"
        },
        "sourceStore": {
          "id": "866d2384-8b34-4cf1-87ce-7481788718af",
          "provisionerId": "directory",
          "displayName": "PingOne Outbound"
        },
        "targetStore": {
          "id": "6d59df96-89b8-4c47-b790-e14b9ede74ab",
          "provisionerId": "LDAPv3DirectoryServer",
          "displayName": "LDAPv3-compliant Directory Server"
        },
        "name": "outbound",
        "description": "",
        "active": false,
        "populationExpression": "population.id eq \"598ee9f7-1c1d-4c38-8530-0ca3af2627d3\"",
        "deprovision": false,
        "configuration": {
          "RDN_ATTRIBUTE": "uid",
          "BASE_DN": "ou=People,dc=pingidentity,dc=org"
        },
        "ruleType": "OUTBOUND",
        "environment": {
          "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "_links": {
          "environment": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
          },
          "update": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/01088dad-f401-4ea8-826f-d40858a686e5"
          },
          "get": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/01088dad-f401-4ea8-826f-d40858a686e5"
          },
          "create": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/cb009b87-963f-48ea-b92e-f5a12bf083aa/rules"
          },
          "delete": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/01088dad-f401-4ea8-826f-d40858a686e5"
          },
          "plan": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/cb009b87-963f-48ea-b92e-f5a12bf083aa"
          },
          "sourceStore": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/866d2384-8b34-4cf1-87ce-7481788718af"
          },
          "targetStore": {
            "href": "https://api.test-one-pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/6d59df96-89b8-4c47-b790-e14b9ede74ab"
          }
        }
      }
    ]
  }
}