PingCentral API Reference

Validate Environment

POST {{baseUrl}}/api/v1/environments/validate

The POST /api/v1/environments/validate endpoint validates the environment.

Headers

Authorization

Content-Type      application/json

Cookie      <string>

X-XSRF-Header      PASS

Body

raw ( application/json )

{
    "description": "<string>",
    "id": "<string>",
    "idpSigningCertificate": "<string>",
    "idpSigningCertificateName": "<string>",
    "idpSigningCertificatePassword": "<string>",
    "name": "<string>",
    "paAuthenticationType": "<string>",
    "paClientId": "<string>",
    "paClientSecret": "<string>",
    "paEnabled": "<boolean>",
    "paHost": "<string>",
    "paPassword": "<string>",
    "paPort": "<integer>",
    "paScopes": "<string>",
    "paSkipVerification": "<boolean>",
    "paTokenEndpoint": "<string>",
    "paUsername": "<string>",
    "paVersion": "<string>",
    "pfAuthenticationType": "<string>",
    "pfClientId": "<string>",
    "pfClientSecret": "<string>",
    "pfHost": "<string>",
    "pfPassword": "<string>",
    "pfPort": "<integer>",
    "pfScopes": "<string>",
    "pfSkipVerification": "<boolean>",
    "pfTokenEndpoint": "<string>",
    "pfUsername": "<string>",
    "pfVersion": "<string>",
    "shielded": "<boolean>",
    "shortCode": "<string>"
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{baseUrl}}/api/v1/environments/validate' \
--header 'Cookie: <string>' \
--header 'X-XSRF-Header: PASS' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==' \
--data '{
    "description": "<string>",
    "id": "<string>",
    "idpSigningCertificate": "<string>",
    "idpSigningCertificateName": "<string>",
    "idpSigningCertificatePassword": "<string>",
    "name": "<string>",
    "paAuthenticationType": "<string>",
    "paClientId": "<string>",
    "paClientSecret": "<string>",
    "paEnabled": "<boolean>",
    "paHost": "<string>",
    "paPassword": "<string>",
    "paPort": "<integer>",
    "paScopes": "<string>",
    "paSkipVerification": "<boolean>",
    "paTokenEndpoint": "<string>",
    "paUsername": "<string>",
    "paVersion": "<string>",
    "pfAuthenticationType": "<string>",
    "pfClientId": "<string>",
    "pfClientSecret": "<string>",
    "pfHost": "<string>",
    "pfPassword": "<string>",
    "pfPort": "<integer>",
    "pfScopes": "<string>",
    "pfSkipVerification": "<boolean>",
    "pfTokenEndpoint": "<string>",
    "pfUsername": "<string>",
    "pfVersion": "<string>",
    "shielded": "<boolean>",
    "shortCode": "<string>"
}'
var options = new RestClientOptions("{{baseUrl}}/api/v1/environments/validate")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Cookie", "<string>");
request.AddHeader("X-XSRF-Header", "PASS");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==");
var body = @"{" + "\n" +
@"    ""description"": ""<string>""," + "\n" +
@"    ""id"": ""<string>""," + "\n" +
@"    ""idpSigningCertificate"": ""<string>""," + "\n" +
@"    ""idpSigningCertificateName"": ""<string>""," + "\n" +
@"    ""idpSigningCertificatePassword"": ""<string>""," + "\n" +
@"    ""name"": ""<string>""," + "\n" +
@"    ""paAuthenticationType"": ""<string>""," + "\n" +
@"    ""paClientId"": ""<string>""," + "\n" +
@"    ""paClientSecret"": ""<string>""," + "\n" +
@"    ""paEnabled"": ""<boolean>""," + "\n" +
@"    ""paHost"": ""<string>""," + "\n" +
@"    ""paPassword"": ""<string>""," + "\n" +
@"    ""paPort"": ""<integer>""," + "\n" +
@"    ""paScopes"": ""<string>""," + "\n" +
@"    ""paSkipVerification"": ""<boolean>""," + "\n" +
@"    ""paTokenEndpoint"": ""<string>""," + "\n" +
@"    ""paUsername"": ""<string>""," + "\n" +
@"    ""paVersion"": ""<string>""," + "\n" +
@"    ""pfAuthenticationType"": ""<string>""," + "\n" +
@"    ""pfClientId"": ""<string>""," + "\n" +
@"    ""pfClientSecret"": ""<string>""," + "\n" +
@"    ""pfHost"": ""<string>""," + "\n" +
@"    ""pfPassword"": ""<string>""," + "\n" +
@"    ""pfPort"": ""<integer>""," + "\n" +
@"    ""pfScopes"": ""<string>""," + "\n" +
@"    ""pfSkipVerification"": ""<boolean>""," + "\n" +
@"    ""pfTokenEndpoint"": ""<string>""," + "\n" +
@"    ""pfUsername"": ""<string>""," + "\n" +
@"    ""pfVersion"": ""<string>""," + "\n" +
@"    ""shielded"": ""<boolean>""," + "\n" +
@"    ""shortCode"": ""<string>""" + "\n" +
@"}";
request.AddStringBody(body, DataFormat.Json);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{baseUrl}}/api/v1/environments/validate"
  method := "POST"

  payload := strings.NewReader(`{
    "description": "<string>",
    "id": "<string>",
    "idpSigningCertificate": "<string>",
    "idpSigningCertificateName": "<string>",
    "idpSigningCertificatePassword": "<string>",
    "name": "<string>",
    "paAuthenticationType": "<string>",
    "paClientId": "<string>",
    "paClientSecret": "<string>",
    "paEnabled": "<boolean>",
    "paHost": "<string>",
    "paPassword": "<string>",
    "paPort": "<integer>",
    "paScopes": "<string>",
    "paSkipVerification": "<boolean>",
    "paTokenEndpoint": "<string>",
    "paUsername": "<string>",
    "paVersion": "<string>",
    "pfAuthenticationType": "<string>",
    "pfClientId": "<string>",
    "pfClientSecret": "<string>",
    "pfHost": "<string>",
    "pfPassword": "<string>",
    "pfPort": "<integer>",
    "pfScopes": "<string>",
    "pfSkipVerification": "<boolean>",
    "pfTokenEndpoint": "<string>",
    "pfUsername": "<string>",
    "pfVersion": "<string>",
    "shielded": "<boolean>",
    "shortCode": "<string>"
}`)

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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Cookie", "<string>")
  req.Header.Add("X-XSRF-Header", "PASS")
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Authorization", "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==")

  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))
}
POST /api/v1/environments/validate HTTP/1.1
Host: {{baseUrl}}
Cookie: <string>
X-XSRF-Header: PASS
Content-Type: application/json
Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==

{
    "description": "<string>",
    "id": "<string>",
    "idpSigningCertificate": "<string>",
    "idpSigningCertificateName": "<string>",
    "idpSigningCertificatePassword": "<string>",
    "name": "<string>",
    "paAuthenticationType": "<string>",
    "paClientId": "<string>",
    "paClientSecret": "<string>",
    "paEnabled": "<boolean>",
    "paHost": "<string>",
    "paPassword": "<string>",
    "paPort": "<integer>",
    "paScopes": "<string>",
    "paSkipVerification": "<boolean>",
    "paTokenEndpoint": "<string>",
    "paUsername": "<string>",
    "paVersion": "<string>",
    "pfAuthenticationType": "<string>",
    "pfClientId": "<string>",
    "pfClientSecret": "<string>",
    "pfHost": "<string>",
    "pfPassword": "<string>",
    "pfPort": "<integer>",
    "pfScopes": "<string>",
    "pfSkipVerification": "<boolean>",
    "pfTokenEndpoint": "<string>",
    "pfUsername": "<string>",
    "pfVersion": "<string>",
    "shielded": "<boolean>",
    "shortCode": "<string>"
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"idpSigningCertificate\": \"<string>\",\n    \"idpSigningCertificateName\": \"<string>\",\n    \"idpSigningCertificatePassword\": \"<string>\",\n    \"name\": \"<string>\",\n    \"paAuthenticationType\": \"<string>\",\n    \"paClientId\": \"<string>\",\n    \"paClientSecret\": \"<string>\",\n    \"paEnabled\": \"<boolean>\",\n    \"paHost\": \"<string>\",\n    \"paPassword\": \"<string>\",\n    \"paPort\": \"<integer>\",\n    \"paScopes\": \"<string>\",\n    \"paSkipVerification\": \"<boolean>\",\n    \"paTokenEndpoint\": \"<string>\",\n    \"paUsername\": \"<string>\",\n    \"paVersion\": \"<string>\",\n    \"pfAuthenticationType\": \"<string>\",\n    \"pfClientId\": \"<string>\",\n    \"pfClientSecret\": \"<string>\",\n    \"pfHost\": \"<string>\",\n    \"pfPassword\": \"<string>\",\n    \"pfPort\": \"<integer>\",\n    \"pfScopes\": \"<string>\",\n    \"pfSkipVerification\": \"<boolean>\",\n    \"pfTokenEndpoint\": \"<string>\",\n    \"pfUsername\": \"<string>\",\n    \"pfVersion\": \"<string>\",\n    \"shielded\": \"<boolean>\",\n    \"shortCode\": \"<string>\"\n}");
Request request = new Request.Builder()
  .url("{{baseUrl}}/api/v1/environments/validate")
  .method("POST", body)
  .addHeader("Cookie", "<string>")
  .addHeader("X-XSRF-Header", "PASS")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{baseUrl}}/api/v1/environments/validate",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Cookie": "<string>",
    "X-XSRF-Header": "PASS",
    "Content-Type": "application/json",
    "Authorization": "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=="
  },
  "data": JSON.stringify({
    "description": "<string>",
    "id": "<string>",
    "idpSigningCertificate": "<string>",
    "idpSigningCertificateName": "<string>",
    "idpSigningCertificatePassword": "<string>",
    "name": "<string>",
    "paAuthenticationType": "<string>",
    "paClientId": "<string>",
    "paClientSecret": "<string>",
    "paEnabled": "<boolean>",
    "paHost": "<string>",
    "paPassword": "<string>",
    "paPort": "<integer>",
    "paScopes": "<string>",
    "paSkipVerification": "<boolean>",
    "paTokenEndpoint": "<string>",
    "paUsername": "<string>",
    "paVersion": "<string>",
    "pfAuthenticationType": "<string>",
    "pfClientId": "<string>",
    "pfClientSecret": "<string>",
    "pfHost": "<string>",
    "pfPassword": "<string>",
    "pfPort": "<integer>",
    "pfScopes": "<string>",
    "pfSkipVerification": "<boolean>",
    "pfTokenEndpoint": "<string>",
    "pfUsername": "<string>",
    "pfVersion": "<string>",
    "shielded": "<boolean>",
    "shortCode": "<string>"
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{baseUrl}}/api/v1/environments/validate',
  'headers': {
    'Cookie': '<string>',
    'X-XSRF-Header': 'PASS',
    'Content-Type': 'application/json',
    'Authorization': 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
  },
  body: JSON.stringify({
    "description": "<string>",
    "id": "<string>",
    "idpSigningCertificate": "<string>",
    "idpSigningCertificateName": "<string>",
    "idpSigningCertificatePassword": "<string>",
    "name": "<string>",
    "paAuthenticationType": "<string>",
    "paClientId": "<string>",
    "paClientSecret": "<string>",
    "paEnabled": "<boolean>",
    "paHost": "<string>",
    "paPassword": "<string>",
    "paPort": "<integer>",
    "paScopes": "<string>",
    "paSkipVerification": "<boolean>",
    "paTokenEndpoint": "<string>",
    "paUsername": "<string>",
    "paVersion": "<string>",
    "pfAuthenticationType": "<string>",
    "pfClientId": "<string>",
    "pfClientSecret": "<string>",
    "pfHost": "<string>",
    "pfPassword": "<string>",
    "pfPort": "<integer>",
    "pfScopes": "<string>",
    "pfSkipVerification": "<boolean>",
    "pfTokenEndpoint": "<string>",
    "pfUsername": "<string>",
    "pfVersion": "<string>",
    "shielded": "<boolean>",
    "shortCode": "<string>"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{baseUrl}}/api/v1/environments/validate"

payload = json.dumps({
  "description": "<string>",
  "id": "<string>",
  "idpSigningCertificate": "<string>",
  "idpSigningCertificateName": "<string>",
  "idpSigningCertificatePassword": "<string>",
  "name": "<string>",
  "paAuthenticationType": "<string>",
  "paClientId": "<string>",
  "paClientSecret": "<string>",
  "paEnabled": "<boolean>",
  "paHost": "<string>",
  "paPassword": "<string>",
  "paPort": "<integer>",
  "paScopes": "<string>",
  "paSkipVerification": "<boolean>",
  "paTokenEndpoint": "<string>",
  "paUsername": "<string>",
  "paVersion": "<string>",
  "pfAuthenticationType": "<string>",
  "pfClientId": "<string>",
  "pfClientSecret": "<string>",
  "pfHost": "<string>",
  "pfPassword": "<string>",
  "pfPort": "<integer>",
  "pfScopes": "<string>",
  "pfSkipVerification": "<boolean>",
  "pfTokenEndpoint": "<string>",
  "pfUsername": "<string>",
  "pfVersion": "<string>",
  "shielded": "<boolean>",
  "shortCode": "<string>"
})
headers = {
  'Cookie': '<string>',
  'X-XSRF-Header': 'PASS',
  'Content-Type': 'application/json',
  'Authorization': 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{baseUrl}}/api/v1/environments/validate');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Cookie' => '<string>',
  'X-XSRF-Header' => 'PASS',
  'Content-Type' => 'application/json',
  'Authorization' => 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
));
$request->setBody('{\n    "description": "<string>",\n    "id": "<string>",\n    "idpSigningCertificate": "<string>",\n    "idpSigningCertificateName": "<string>",\n    "idpSigningCertificatePassword": "<string>",\n    "name": "<string>",\n    "paAuthenticationType": "<string>",\n    "paClientId": "<string>",\n    "paClientSecret": "<string>",\n    "paEnabled": "<boolean>",\n    "paHost": "<string>",\n    "paPassword": "<string>",\n    "paPort": "<integer>",\n    "paScopes": "<string>",\n    "paSkipVerification": "<boolean>",\n    "paTokenEndpoint": "<string>",\n    "paUsername": "<string>",\n    "paVersion": "<string>",\n    "pfAuthenticationType": "<string>",\n    "pfClientId": "<string>",\n    "pfClientSecret": "<string>",\n    "pfHost": "<string>",\n    "pfPassword": "<string>",\n    "pfPort": "<integer>",\n    "pfScopes": "<string>",\n    "pfSkipVerification": "<boolean>",\n    "pfTokenEndpoint": "<string>",\n    "pfUsername": "<string>",\n    "pfVersion": "<string>",\n    "shielded": "<boolean>",\n    "shortCode": "<string>"\n}');
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 "json"
require "net/http"

url = URI("{{baseUrl}}/api/v1/environments/validate")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Cookie"] = "<string>"
request["X-XSRF-Header"] = "PASS"
request["Content-Type"] = "application/json"
request["Authorization"] = "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=="
request.body = JSON.dump({
  "description": "<string>",
  "id": "<string>",
  "idpSigningCertificate": "<string>",
  "idpSigningCertificateName": "<string>",
  "idpSigningCertificatePassword": "<string>",
  "name": "<string>",
  "paAuthenticationType": "<string>",
  "paClientId": "<string>",
  "paClientSecret": "<string>",
  "paEnabled": "<boolean>",
  "paHost": "<string>",
  "paPassword": "<string>",
  "paPort": "<integer>",
  "paScopes": "<string>",
  "paSkipVerification": "<boolean>",
  "paTokenEndpoint": "<string>",
  "paUsername": "<string>",
  "paVersion": "<string>",
  "pfAuthenticationType": "<string>",
  "pfClientId": "<string>",
  "pfClientSecret": "<string>",
  "pfHost": "<string>",
  "pfPassword": "<string>",
  "pfPort": "<integer>",
  "pfScopes": "<string>",
  "pfSkipVerification": "<boolean>",
  "pfTokenEndpoint": "<string>",
  "pfUsername": "<string>",
  "pfVersion": "<string>",
  "shielded": "<boolean>",
  "shortCode": "<string>"
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"description\": \"<string>\",\n    \"id\": \"<string>\",\n    \"idpSigningCertificate\": \"<string>\",\n    \"idpSigningCertificateName\": \"<string>\",\n    \"idpSigningCertificatePassword\": \"<string>\",\n    \"name\": \"<string>\",\n    \"paAuthenticationType\": \"<string>\",\n    \"paClientId\": \"<string>\",\n    \"paClientSecret\": \"<string>\",\n    \"paEnabled\": \"<boolean>\",\n    \"paHost\": \"<string>\",\n    \"paPassword\": \"<string>\",\n    \"paPort\": \"<integer>\",\n    \"paScopes\": \"<string>\",\n    \"paSkipVerification\": \"<boolean>\",\n    \"paTokenEndpoint\": \"<string>\",\n    \"paUsername\": \"<string>\",\n    \"paVersion\": \"<string>\",\n    \"pfAuthenticationType\": \"<string>\",\n    \"pfClientId\": \"<string>\",\n    \"pfClientSecret\": \"<string>\",\n    \"pfHost\": \"<string>\",\n    \"pfPassword\": \"<string>\",\n    \"pfPort\": \"<integer>\",\n    \"pfScopes\": \"<string>\",\n    \"pfSkipVerification\": \"<boolean>\",\n    \"pfTokenEndpoint\": \"<string>\",\n    \"pfUsername\": \"<string>\",\n    \"pfVersion\": \"<string>\",\n    \"shielded\": \"<boolean>\",\n    \"shortCode\": \"<string>\"\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{baseUrl}}/api/v1/environments/validate")!,timeoutInterval: Double.infinity)
request.addValue("<string>", forHTTPHeaderField: "Cookie")
request.addValue("PASS", forHTTPHeaderField: "X-XSRF-Header")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")
request.addValue("Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==", forHTTPHeaderField: "Authorization")

request.httpMethod = "POST"
request.httpBody = postData

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

{
  "environmentView": {
    "description": "Description of the environment.",
    "id": "cd00f834-0c26-45ec-9410-cc38156cb4d4",
    "idpSigningCertificate": true,
    "idpSigningCertificateName": "signingCertificate.p12",
    "idpSigningCertificatePassword": "password",
    "name": "Development",
    "paEnabled": true,
    "paHost": "pingidentity.com",
    "paPassword": "password",
    "paPort": 9000,
    "paSkipVerification": false,
    "paUsername": "administrator",
    "paVersion": 6.2,
    "paAuthenticationType": "PASSWORD",
    "paClientId": null,
    "paClientSecret": null,
    "paScopes": null,
    "paTokenEndpoint": null,
    "pfHost": "pingidentity.com",
    "pfPassword": "password",
    "pfPort": 9999,
    "pfSkipVerification": false,
    "pfUsername": "administrator",
    "pfVersion": 10.2,
    "pfAuthenticationType": "PASSWORD",
    "pfClientId": null,
    "pfClientSecret": null,
    "pfTokenEndpoint": null,
    "pfScopes": null,
    "shielded": true,
    "shortCode": "DEV"
  },
  "errors": [
    "Unable to validate environment."
  ]
}