PingOne Platform APIs

Read All Stores

 

GET {{apiPath}}/environments/{{envID}}/propagation/stores

The GET {{apiPath}}/environments/{{envID}}/propagation/stores endpoint returns a list of all identity store resources associated with the specified environment resource.

Included is each store’s sync status (syncStatus), indicating the current status (either "Syncing" or "Failed"), last provisioned date-time, as well as successful or failed sync counts, and user totals.

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

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/stores');
$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/stores")

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/stores")!,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": {
        "stores": [
            {
                "id": "02b56e18-2b86-40c6-af2f-2540c25b99e7",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-02-04T14:43:57.678Z",
                "updatedAt": "2022-02-04T14:43:57.678Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "type": "PingOne",
                "status": "INACTIVE",
                "configuration": {
                    "ENVIRONMENT_ID": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
                    "REGION": "North America"
                },
                "name": "PingOneTest"
            },
            {
                "id": "13f3a0c7-9e91-4801-a566-8672eb2143c2",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-03-02T15:05:02.129Z",
                "updatedAt": "2022-03-02T15:05:02.129Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "type": "scim",
                "status": "INACTIVE",
                "configuration": {
                    "AUTHENTICATION_METHOD": "None",
                    "USER_FILTER": "username Eq \"%s\"",
                    "UNIQUE_USER_IDENTIFIER": "userName",
                    "REMOVE_ACTION": "Disable",
                    "CREATE_USERS": true,
                    "UPDATE_USERS": true,
                    "DISABLE_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": "scim"
            },
            {
                "id": "3277e244-ccc7-4d98-b313-22c38a5c7d35",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-01-13T21:31:35.985Z",
                "updatedAt": "2022-01-13T21:31:35.985Z",
                "image": {},
                "type": "Salesforce",
                "status": "INACTIVE",
                "configuration": {
                    "FREEZE_USER_FLAG": false,
                    "ENABLE_COMMUNITIES": true,
                    "PERMISSION_SET_MANAGEMENT": "Merge with permission sets in Salesforce",
                    "CREATE_NEW_USERS": true,
                    "UPDATE_NEW_USERS": true,
                    "DISABLE_USERS": true,
                    "PROVISION_DISABLED_USERS": true,
                    "SALESFORCE_DOMAIN": "https://example.com",
                    "CLIENT_ID": "fdsfd",
                    "CLIENT_SECRET": "fdsafds",
                    "OAUTH_ACCESS_TOKEN": "fdsfds",
                    "OAUTH_REFRESH_TOKEN": "fdsfdsa"
                },
                "name": "test"
            },
            {
                "id": "3810dbfa-5ab8-4976-8ecf-e011aed758af",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-02-04T14:29:40.597Z",
                "updatedAt": "2022-02-04T14:29:40.597Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "type": "Workday",
                "status": "INACTIVE",
                "configuration": {
                    "username": "basicUserName",
                    "password": "$3cr3t_p@55w0rd",
                    "tenantId": "tenant_Id",
                    "subdomain": "subdomain"
                },
                "name": "WorkdayTest"
            },
            {
                "id": "47db21cc-86b1-4cfa-9ca0-53c9d818b894",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-03-01T19:51:07.313Z",
                "updatedAt": "2022-03-01T19:51:07.313Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "type": "AzureActiveDirectorySAML2",
                "status": "INACTIVE",
                "configuration": {
                    "REMOVE_USERS_PROV_OPT": true,
                    "DEPROVISION_USER_ACTION_PROV_OPT": "Disable",
                    "CREATE_USERS": true,
                    "UPDATE_USERS": true,
                    "DISABLE_USERS": true,
                    "DEPROVISION_USERS": true,
                    "REMOVE_ACTION": "Disable",
                    "TenantDomain": "tenant_domain",
                    "ClientId": "azureADClientID",
                    "ClientSecret": "azureADClientSecret",
                    "DefaultPassword": "$3cr3t_p@55w0rd"
                },
                "name": "azureTest2"
            },
            {
                "id": "487261b0-277f-48e1-8a84-cc731c4c4591",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                },
                "createdAt": "2022-03-01T19:56:03.881Z",
                "updatedAt": "2022-03-01T19:56:03.881Z",
                "image": {
                    "href": "https://d1oekt4jpdthse.cloudfront.net/branding/market/cb933bfe-8282-405a-a780-0a19b97edc02.png"
                },
                "type": "AzureActiveDirectorySAML2",
                "status": "INACTIVE",
                "configuration": {
                    "REMOVE_USERS_PROV_OPT": true,
                    "DEPROVISION_USER_ACTION_PROV_OPT": "Disable",
                    "CREATE_USERS": true,
                    "UPDATE_USERS": true,
                    "DISABLE_USERS": true,
                    "DEPROVISION_USERS": true,
                    "REMOVE_ACTION": "Disable",
                    "TenantDomain": "tenant_domain",
                    "ClientId": "azureADClientID",
                    "ClientSecret": "azureADClientSecret",
                    "DefaultPassword": "$3cr3t_p@55w0rd"
                },
                "name": "azureTest1"
            },
            {
                "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"
            },
            {
                "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/"
        }
    }
}