Get Certificates

GET {{apiPath}}/environments/{{envID}}/certificates

The GET {{apiPath}}/environments/{{envID}}/certificates endpoint returns a list of all certificate resources for the specified environment.

To return certificates in PKCS #12 format, in the header, specify an Accept key with a value of application/x-pkcs12. A binary representation of the certificates is returned, as shown in the second response example. To return certificates in PEM format, in the header, specify an Accept key with a value of application/x-pem-file. The certificates are returned in PEM format, as shown in the third response example.

Query parameters

Parameter Description

Parameter	Description
`filter`	N/A
`limit`	From 1-5000 inclusive. Defaults to 5000.
`cursor`	Indicates the first item to retrieve.

filter

N/A

limit

From 1-5000 inclusive. Defaults to 5000.

cursor

Indicates the first item to retrieve.

Headers

Authorization Bearer {{accessToken}}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/certificates' \
--header 'Authorization: Bearer {{accessToken}}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/certificates")
{
  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/{{envID}}/certificates"
  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/{{envID}}/certificates 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/{{envID}}/certificates")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/certificates",
  "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/{{envID}}/certificates',
  'headers': {
    'Authorization': 'Bearer {{accessToken}}'
  }
};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

import requests

url = "{{apiPath}}/environments/{{envID}}/certificates"

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

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/{{envID}}/certificates")!,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/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/certificates"
        }
    },
    "_embedded": {
        "certificates": [
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/certificates/da8d3dad-9dc6-44a3-832f-3ec5f2e246a9"
                    }
                },
                "id": "da8d3dad-9dc6-44a3-832f-3ec5f2e246a9",
                "name": "Default-Test_Env1",
                "serialNumber": 1560537951378,
                "issuerDN": "CN=Default-Test_Env1,OU=Ping Identity,O=Ping Identity,C=US",
                "subjectDN": "CN=Default-Test_Env1,OU=Ping Identity,O=Ping Identity,C=US",
                "algorithm": "RSA",
                "keyLength": 2048,
                "createdAt": "2019-12-04T17:22:29.778Z",
                "expiresAt": "2020-06-13T18:45:51.000Z",
                "startsAt": "2019-06-14T18:45:51.000Z",
                "validityPeriod": 365,
                "signatureAlgorithm": "SHA256withRSA",
                "usageType": "ENCRYPTION",
                "status": "VALID",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                }
            },
            {
                "_links": {
                    "self": {
                        "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/certificates/fce54cf6-6bb2-4707-b412-6ab50f4eb2d0"
                    }
                },
                "id": "fce54cf6-6bb2-4707-b412-6ab50f4eb2d0",
                "name": "Default-Test_Env1",
                "serialNumber": 1560537951378,
                "issuerDN": "CN=Default-Test_Env1,OU=Ping Identity,O=Ping Identity,C=US",
                "subjectDN": "CN=Default-Test_Env1,OU=Ping Identity,O=Ping Identity,C=US",
                "algorithm": "RSA",
                "keyLength": 2048,
                "createdAt": "2019-12-04T17:22:12.695Z",
                "expiresAt": "2020-06-13T18:45:51.000Z",
                "startsAt": "2019-06-14T18:45:51.000Z",
                "validityPeriod": 365,
                "signatureAlgorithm": "SHA256withRSA",
                "usageType": "ENCRYPTION",
                "status": "VALID",
                "environment": {
                    "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
                }
            }
        ]
    },
    "size": 2
}

Example Response

200 OK

0V0	*�H��
�00>0!0	+���$��YS�U���҂tdh�9������u������1V��

Example Response

200 OK

PingOne Platform APIs

Get Certificates

Headers

Example Request

Example Response

Example Response

Example Response