PingOne Platform APIs

Download One Integration Version Asset

   

GET {{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset

Use the GET {{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset endpoint to download the integration asset specified by {{integrationID}} and {{integrationVersionID}}.

To complete the download, the endpoint will redirect to a time-limited presigned URL with response code "307 Temporary Redirect".

Response headers will include:

Key Value

Content-Type

application/zip or application/x-zip-compressed

Content-Disposition

attachment;filename={version.name}-{version.number}.zip

x-amz-meta-etag

sha256 hash you can use as integrity check

The maximum download size is 50 MB.

Headers

Authorization      Bearer {{accessToken}}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset' \
--header 'Authorization: Bearer {{accessToken}}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset")
{
  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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset"
  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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset 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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset")
  .method("GET", body)
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset",
  "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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset',
  '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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset"

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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset');
$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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset")

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}}/integrations/{{integrationID}}/versions/{{integrationVersionID}}/asset")!,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

<?xml version="1.0" encoding="UTF-8"?>
<urn:EntityDescriptor entityID="south_entity" xmlns:urn="urn:oasis:names:tc:SAML:2.0:metadata">
    <urn:SPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" WantAssertionsSigned="true">
        <urn:SingleLogoutService Location="https://request.south.com" ResponseLocation="https://response.south.com" Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect"/>
        <urn:AssertionConsumerService index="0" Location="https://${parameters.subdomain}.south.com"/>
        <urn:AttributeConsumingService index="0">
            <urn:ServiceName xml:lang="en">AttributeContract</urn:ServiceName>
            <urn:RequestedAttribute isRequired="true" Name="att1:name2:value3"/>
        </urn:AttributeConsumingService>
    </urn:SPSSODescriptor>
</urn:EntityDescriptor>