PingOne Platform APIs

Read All Environments

       

GET {{apiPath}}/environments

You can get all environment resources for an organization, a selected set of environments (using a filter), or a specific environment.

The sample shows the GET {{apiPath}}/environments operation to return all environments associated with the organization.

This request supports the limit parameter (for example, ?limit=1). You can also use limit in conjunction with an eq SCIM filtering expression that includes organization.id or license.id (for example, ?filter=license.id eq "34f0efac-21d9-4a17-8a35-196bb3362983"&limit=1. If you use limit with other supported SCIM filtering options, limit is ignored.

The GET {{apiPath}}/environments and GET {{apiPath}}/environments/{{envID}} endpoints allow an expand query parameter on the billOfMaterials embedded resource. Queries that expand billOfMaterials show the licensed product information encapsulated in the environment’s Bill of Materials as an _embedded resource. Refer to the response data for details.

Query parameters
Query parameter Attributes (or allowed limits)

filter

* name (sw)

* id (eq)

* organization.id (eq)

* license.id (eq)

* status (eq)

limit

(1-500)

expand

expand=billOfMaterials

order

N/A

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Get);
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"
  method := "GET"

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

  if err != nil {
    fmt.Println(err)
    return
  }
  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 HTTP/1.1
Host: {{apiPath}}
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")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments",
  "method": "GET",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer {{accessToken}}"
  },
};

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

url = "{{apiPath}}/environments"

payload = {}
headers = {
  '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');
$request->setMethod(HTTP_Request2::METHOD_GET);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  '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")

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

response = http.request(request)
puts response.read_body
var request = URLRequest(url: URL(string: "{{apiPath}}/environments")!,timeoutInterval: Double.infinity)
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

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments"
        }
    },
    "_embedded": {
        "environments": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88"
                    },
                    "license": {
                        "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"
                    },
                    "organization": {
                        "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
                    },
                    "populations": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/populations"
                    },
                    "users": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/users"
                    },
                    "applications": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/applications"
                    },
                    "activities": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/activities"
                    },
                    "branding": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/branding"
                    },
                    "features": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/features"
                    },
                    "resources": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/resources"
                    },
                    "passwordPolicies": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/passwordPolicies"
                    },
                    "userActivities": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/userActivities"
                    },
                    "signOnPolicies": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/signOnPolicies"
                    },
                    "keys": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/keys"
                    },
                    "templates": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/templates"
                    },
                    "notificationsSettings": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/notificationsSettings"
                    },
                    "schemas": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/schemas"
                    },
                    "gateways": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/gateways"
                    },
                    "capabilities": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/capabilities"
                    },
                    "activeIdentityCounts": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/activeIdentityCounts"
                    },
                    "propagation/plans": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/propagation/plans"
                    },
                    "propagation/stores": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/propagation/stores"
                    },
                    "propagation/revisions/id:latest": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/propagation/revisions/id:latest"
                    },
                    "billOfMaterials": {
                        "href": "https://api.pingone.com/v1/environments/4aa9e980-22dd-427b-9976-f9c6f96f1a88/billOfMaterials"
                    }
                },
                "_embedded": {
                    "billOfMaterials": {
                        "products": [
                            {
                                "id": "5de6a85e-1312-4e40-97be-a546a0ed29e6",
                                "type": "PING_ONE_BASE",
                                "description": "PingOne Base"
                            },
                            {
                                "id": "74e9d0df-fd02-455e-8537-83cd4f4a2354",
                                "type": "PING_ONE_MFA",
                                "description": "PingOne MFA"
                            },
                            {
                                "id": "0e4ca1d0-4a1d-46bb-bdc5-d42bb13c0428",
                                "type": "PING_ONE_RISK",
                                "description": "PingOne Risk"
                            },
                            {
                                "id": "890aea3d-9584-49e1-ba9b-04da7eb73eb2",
                                "type": "PING_ONE_PROVISIONING",
                                "description": "PingOne Provisioning"
                            }
                        ],
                        "createdAt": "2020-06-10T22:20:59.840Z",
                        "updatedAt": "2020-06-10T22:20:59.840Z"
                    }
                },
                "id": "4aa9e980-22dd-427b-9976-f9c6f96f1a88",
                "name": "TestEnv2",
                "description": "Another test environment",
                "organization": {
                    "id": "bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
                },
                "type": "SANDBOX",
                "region": "NA",
                "createdAt": "2020-06-10T22:20:59.826Z",
                "updatedAt": "2020-06-10T22:20:59.826Z",
                "license": {
                    "id": "57f0efac-37d9-4a17-8a35-196bb3362983"
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "license": {
                        "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"
                    },
                    "organization": {
                        "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
                    },
                    "populations": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations"
                    },
                    "users": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users"
                    },
                    "applications": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications"
                    },
                    "activities": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities"
                    },
                    "branding": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/branding"
                    },
                    "features": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/features"
                    },
                    "resources": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources"
                    },
                    "passwordPolicies": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/passwordPolicies"
                    },
                    "userActivities": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/userActivities"
                    },
                    "signOnPolicies": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies"
                    },
                    "keys": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys"
                    },
                    "templates": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates"
                    },
                    "notificationsSettings": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings"
                    },
                    "schemas": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/schemas"
                    },
                    "gateways": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways"
                    },
                    "capabilities": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/capabilities"
                    },
                    "activeIdentityCounts": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activeIdentityCounts"
                    },
                    "propagation/plans": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans"
                    },
                    "propagation/stores": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores"
                    },
                    "propagation/revisions/id:latest": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/revisions/id:latest"
                    },
                    "billOfMaterials": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/billOfMaterials"
                    }
                },
                "_embedded": {
                    "billOfMaterials": {
                        "products": [
                            {
                                "id": "1db94cdc-ed36-4e20-9efd-12d879a7108e",
                                "type": "PING_DIRECTORY",
                                "description": "PingOne Directory"
                            },
                            {
                                "id": "144f6736-37d2-482e-8097-aedd4a1e9c71",
                                "type": "PING_ONE_MFA",
                                "description": "PingOne MFA"
                            },
                            {
                                "id": "fdf14171-5314-4023-a620-ff1876a01c9f",
                                "type": "PING_ONE_PROVISIONING",
                                "description": "PingOne Provisioning"
                            },
                            {
                                "id": "eef5ee8a-b1f6-4888-9f0d-c0ba0d2f606e",
                                "type": "PING_ONE_RISK",
                                "description": "PingOne Risk"
                            }
                        ],
                        "createdAt": "2020-05-27T16:02:10.204Z",
                        "updatedAt": "2020-05-27T17:08:08.473Z"
                    }
                },
                "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
                "name": "Default",
                "description": "This is the initial environment created when the Organization was provisioned.",
                "organization": {
                    "id": "bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
                },
                "type": "SANDBOX",
                "region": "NA",
                "createdAt": "2019-05-21T17:47:23.750Z",
                "updatedAt": "2019-11-06T19:07:51.439Z",
                "license": {
                    "id": "57f0efac-37d9-4a17-8a35-196bb3362983"
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                    },
                    "license": {
                        "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda/licenses/57f0efac-37d9-4a17-8a35-196bb3362983"
                    },
                    "organization": {
                        "href": "https://api.pingone.com/v1/organizations/bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
                    },
                    "populations": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations"
                    },
                    "users": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users"
                    },
                    "applications": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications"
                    },
                    "activities": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activities"
                    },
                    "branding": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/branding"
                    },
                    "features": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/features"
                    },
                    "resources": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/resources"
                    },
                    "passwordPolicies": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/passwordPolicies"
                    },
                    "userActivities": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/userActivities"
                    },
                    "signOnPolicies": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/signOnPolicies"
                    },
                    "keys": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys"
                    },
                    "templates": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/templates"
                    },
                    "notificationsSettings": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/notificationsSettings"
                    },
                    "schemas": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/schemas"
                    },
                    "gateways": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/gateways"
                    },
                    "capabilities": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/capabilities"
                    },
                    "activeIdentityCounts": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/activeIdentityCounts"
                    },
                    "propagation/plans": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/plans"
                    },
                    "propagation/stores": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/stores"
                    },
                    "propagation/revisions/id:latest": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/propagation/revisions/id:latest"
                    },
                    "billOfMaterials": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/billOfMaterials"
                    }
                },
                "_embedded": {
                    "billOfMaterials": {
                        "products": [
                            {
                                "id": "0295a148-f20f-44a9-b8d2-85be8217184a",
                                "type": "PING_ONE_BASE",
                                "description": "PingOne Base"
                            },
                            {
                                "id": "93745673-51a0-4abb-a557-7a2cb0a135b0",
                                "type": "PING_ONE_MFA",
                                "description": "PingOne MFA"
                            },
                            {
                                "id": "62c264ca-37d9-452c-ac76-91dc7e2e4836",
                                "type": "PING_ONE_RISK",
                                "description": "PingOne Risk"
                            },
                            {
                                "id": "a4fc81bf-8d69-4b22-8188-c03e143df667",
                                "type": "PING_ONE_PROVISIONING",
                                "description": "PingOne Provisioning"
                            }
                        ],
                        "createdAt": "2020-06-12T17:48:47.262Z",
                        "updatedAt": "2020-06-12T17:48:47.262Z"
                    }
                },
                "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
                "name": "Test_Env1",
                "description": "Test environment 1",
                "organization": {
                    "id": "bed432e6-676a-4ebe-b5a5-6b3b54e46bda"
                },
                "type": "SANDBOX",
                "region": "NA",
                "createdAt": "2019-06-14T18:45:51.166Z",
                "updatedAt": "2019-06-14T18:45:51.166Z",
                "license": {
                    "id": "57f0efac-37d9-4a17-8a35-196bb3362983"
                }
            }
        ]
    },
    "size": 3
}