PingOne Platform APIs

Read Previous Propagation Revision

 

GET {{apiPath}}/environments/{{envID}}/propagation/revisions/{{previousRevisionID}}

The GET {{apiPath}}/environments/{{envID}}/propagation/revisions/{{previousRevisionID}} operation returns one propagation configuration revision.

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/revisions/{{previousRevisionID}}' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/propagation/revisions/{{previousRevisionID}}")
{
  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/revisions/{{previousRevisionID}}"
  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/revisions/{{previousRevisionID}} 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/revisions/{{previousRevisionID}}")
  .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/revisions/{{previousRevisionID}}",
  "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/revisions/{{previousRevisionID}}',
  '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/revisions/{{previousRevisionID}}"

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/revisions/{{previousRevisionID}}');
$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/revisions/{{previousRevisionID}}")

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/revisions/{{previousRevisionID}}")!,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

{
    "id": "a20a7660-74b5-11ec-a963-b37d330ca94f",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "createdAt": "2022-01-13T21:13:19.814Z",
    "_links": {
        "latest": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/revisions/id:latest"
        },
        "create": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/revisions"
        },
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/revisions/a20a7660-74b5-11ec-a963-b37d330ca94f"
        }
    },
    "_embedded": {
        "plans": [
            {
                "id": "ea142a22-61d8-4df7-a93e-8de943c526fe",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "name": "Default Plan",
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/ea142a22-61d8-4df7-a93e-8de943c526fe"
                    }
                },
                "_embedded": {
                    "rules": [
                        {
                            "id": "f9d4c0fc-269d-4645-9079-2795b18f06a6",
                            "environment": {
                                "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                            },
                            "createdAt": "2022-01-13T20:37:29.220Z",
                            "updatedAt": "2022-01-13T20:37:29.220Z",
                            "plan": {
                                "id": "ea142a22-61d8-4df7-a93e-8de943c526fe"
                            },
                            "sourceStore": {
                                "id": "a7115f69-136d-4b5d-8b24-5c1c218147f5"
                            },
                            "targetStore": {
                                "id": "9f95941f-9870-448c-9ff6-2a132e4b5d5a"
                            },
                            "active": false,
                            "deprovision": true,
                            "populations": [
                                {
                                    "id": "cb3ef0a0-0ff5-4f60-ae82-4ae65d9d0e3a"
                                }
                            ],
                            "_links": {
                                "self": {
                                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/rules/f9d4c0fc-269d-4645-9079-2795b18f06a6"
                                },
                                "targetStore": {
                                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/9f95941f-9870-448c-9ff6-2a132e4b5d5a"
                                },
                                "sourceStore": {
                                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
                                },
                                "plan": {
                                    "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans/ea142a22-61d8-4df7-a93e-8de943c526fe"
                                }
                            },
                            "_embedded": {
                                "mappings": []
                            }
                        }
                    ]
                }
            }
        ],
        "stores": [
            {
                "id": "9f95941f-9870-448c-9ff6-2a132e4b5d5a",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-01-10T21:13:01.061Z",
                "updatedAt": "2022-01-10T21:13:01.061Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "type": "Aquera",
                "status": "INACTIVE",
                "configuration": {
                    "AUTHENTICATION_METHOD": "None",
                    "USER_FILTER": "username Eq \"%s\"",
                    "UNIQUE_USER_IDENTIFIER": "userName",
                    "REMOVE_ACTION": "Disable",
                    "CREATE_NEW_USERS": true,
                    "UPDATE_NEW_USERS": true,
                    "DISABLE_NEW_USERS": true,
                    "USERS_RESOURCE": "/Users",
                    "SCIM_VERSION": "2.0",
                    "SCIM_URL": "https://example.com",
                    "AUTHORIZATION_TYPE": "Basic",
                    "BASIC_AUTH_USER": "basicUserName",
                    "BASIC_AUTH_PASSWORD": "$3cr3t_p@55w0rd"
                },
                "name": "AqueraTest",
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/9f95941f-9870-448c-9ff6-2a132e4b5d5a"
                    }
                }
            },
            {
                "id": "a7115f69-136d-4b5d-8b24-5c1c218147f5",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-01-10T17:32:21.502Z",
                "updatedAt": "2022-01-10T20:29:55.593Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "description": "Update a scim connection",
                "type": "scim",
                "configuration": {
                    "AUTHENTICATION_METHOD": "Basic Authentication",
                    "SCIM_URL": "https://scim.url",
                    "USERS_RESOURCE": "/users",
                    "SCIM_VERSION": "1.1",
                    "AUTHORIZATION_TYPE": "Basic",
                    "BASIC_AUTH_USER": "basicUserName",
                    "BASIC_AUTH_PASSWORD": "$3cr3t_p@55w0rd"
                },
                "name": "scim",
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores/a7115f69-136d-4b5d-8b24-5c1c218147f5"
                    }
                }
            }
        ]
    }
}