PingOne Platform APIs

Create Application (SAML Protocol) - XML Metadata

POST {{apiPath}}/v1/environments/{{envID}}/applications

Use the POST {{apiPath}}/v1/environments/{{envID}}/applications operation to add a new application to the environment based on the specified SP metadata XML file. The Content-Type header must be set to application/samlmetadata+xml.

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/samlmetadata+xml

Accept      application/json, /

Body

file ( application/samlmetadata+xml )

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/v1/environments/{{envID}}/applications' \
--header 'Content-Type: application/samlmetadata+xml' \
--header 'Accept: application/json, */*' \
--header 'Authorization: Bearer {{accessToken}}' \
--data-binary '@/Users/kbentley/Downloads/saml2-metadata-sp.xml'
var options = new RestClientOptions("{{apiPath}}/v1/environments/{{envID}}/applications")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/samlmetadata+xml");
request.AddHeader("Accept", "application/json, */*");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
request.AddParameter("application/samlmetadata+xml", "<file contents here>", ParameterType.RequestBody);
RestResponse response = await client.ExecuteAsync(request);
Console.WriteLine(response.Content);
package main

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

func main() {

  url := "{{apiPath}}/v1/environments/{{envID}}/applications"
  method := "POST"

  payload := strings.NewReader("<file contents here>")


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

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/samlmetadata+xml")
  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))
}
POST /v1/environments/{{envID}}/applications HTTP/1.1
Host: {{apiPath}}
Content-Type: application/samlmetadata+xml
Accept: application/json, */*
Authorization: Bearer {{accessToken}}

"<file contents here>"
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/samlmetadata+xml");
RequestBody body = RequestBody.create(mediaType, "<file contents here>");
Request request = new Request.Builder()
  .url("{{apiPath}}/v1/environments/{{envID}}/applications")
  .method("POST", body)
  .addHeader("Content-Type", "application/samlmetadata+xml")
  .addHeader("Accept", "application/json, */*")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{apiPath}}/v1/environments/{{envID}}/applications",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/samlmetadata+xml",
    "Accept": "application/json, */*",
    "Authorization": "Bearer {{accessToken}}"
  },
   "data": "<file contents here>"
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/v1/environments/{{envID}}/applications',
  'headers': {
    'Content-Type': 'application/samlmetadata+xml',
    'Accept': 'application/json, */*',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: "<file contents here>"

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

url = "{{apiPath}}/v1/environments/{{envID}}/applications"

payload = "<file contents here>"
headers = {
  'Content-Type': 'application/samlmetadata+xml',
  'Accept': 'application/json, */*',
  'Authorization': 'Bearer {{accessToken}}'
}

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

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/v1/environments/{{envID}}/applications');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/samlmetadata+xml',
  'Accept' => 'application/json, */*',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('<file contents here>');
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}}/v1/environments/{{envID}}/applications")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/samlmetadata+xml"
request["Accept"] = "application/json, */*"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = "<file contents here>"

response = http.request(request)
puts response.read_body
let parameters = "<file contents here>"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{apiPath}}/v1/environments/{{envID}}/applications")!,timeoutInterval: Double.infinity)
request.addValue("application/samlmetadata+xml", forHTTPHeaderField: "Content-Type")
request.addValue("application/json, */*", forHTTPHeaderField: "Accept")
request.addValue("Bearer {{accessToken}}", 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

{
    "entityId": "https://test.example.com/saml/metadata",
    "acsBinding": "HTTP_POST",
    "acsUrls": [
        "https://test.example.com/saml/acs"
    ],
    "sloEndpoint": "https://test.example.com/saml/slo",
    "sloBinding": "HTTP_REDIRECT",
    "authnRequestsSigned": true,
    "signingCertificates": [
        {
            "pkcs7Der": "MIAGCSqGSIb3DQEHAqCAMIACAQExADALBgkqhkiG9w0BBwGggDCCBWswggNToAMCAQICFEPudg2y03FF8RqPNfDpiNjH721AMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMjYwNzMwMTUwNDUwWhcNMjcwNzMwMTUwNDUwWjBFMQswCQYDVQQGEwJVUzETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAyKX5HhQiVU+rqpBEW+b/yPX/rH34FyJvhcZwj4jQhD74q22bEKW8P5mdHshTYIGyNqhcu+P6LlXr+IJWN8XQyaKE83yjqpGODrQY9rgFbft2WH264Xtaow9YA9eeJSomPTZ96CmGIr4+SesWoFQdre1CXNUwr5HMEYW0hPdR7fDNVoEHfDYZWzeSeLllJ+JLoqoX5YiiAJKw9Kz6eOeqs1Ln4qL7PNwF2l4xgLwT4Am4B0kQH8MavBHZUvzoaDk8ygEGDsub0IbSSprEET0mlOOThp9euhL9fYUES/EA63fv1ZXMVQAQuLMYqD4iWctW/7d1XE3ckSoqk7s6/+WYufREdANBMez++c59e8s5KeYqmse01btuV/GAnP244ijOqxC4bW04p9RSggvkN5qBxCjx1GbtGwvIHRdRT0NKmAzq537rq/y4FV9AFBvoR5yc2iZR1O0qCrszZ1V1sVTyOCFWnETTRmYgQDkYxcP2cC3fXDha6Nz22T4pranz+1z5Huj0l4SOO3+OMXiPnOxZMDRxA1GISAwVbh6h38PC/tudUwyzvum1oNb/9fHJkLY7Iywxkplngo4juWwamGU6hzuxjT7V3Gc0PhiNl072C95LhxDUkmzb0ywfw2w0GovvPNRITGElgJzAY2mCVlOt+zSdwvCON1O61iHCFAOiQ4MCAwEAAaNTMFEwHQYDVR0OBBYEFGx0QdpahDHNaPtg6xRj6XVcXd/jMB8GA1UdIwQYMBaAFGx0QdpahDHNaPtg6xRj6XVcXd/jMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggIBAE4WO1d0AHPKzEHRslQnxnFJzqPF7XJUw1iUX9B8DpflhscLQL0SWiIbXCFhpMXrRzorCkRZNJ09LS+D1ql6MwPjqlVhTgqTvrRWiquvTeaIpsa39KpdbJ23+rVTqzpjugJgtu9XXmXFak7YbTXkOPts9KnDVEPd1zNfmDp6xA8pdKyf3Oxorj8iDOIofXw734zSKT4XNmgs41d9SGlUKMuHypgE1vIdX53BRZxsJ9E27rewfNfwSxtfaXvb8xKlo5QuSavkrM0EZV+rwYcvpCvlTLTFoNab1PEpmqjiAzrv2ClpCXFoDy6lqIipsfSBXARuxqTHwOmrKXEUuyyDhuaZVMdVhz0bPr/t0cl+gf2yvnXff+yXoTcR/F09B5oaA5PfKYryoINSuYDKDztp2BSFumm4owlRhqYFodBAfJOgyhQv116UjBFuSYDNGnn235JmNFWMEIewo+XjXo2sMx6jecz7D4t66JKouIenWaCsWSORonoAIWja9fhqsHaCJLstXhBwPaTZWRv5/FKaDI+gIwS3fkOhUdU+Xm4TxlvGXchimz6sBj21NhseMwDb9vCps1+Qq3+Yn9ZF3MrMIYOieS0QKrVKbWjLQPjQy0kl6yOg4gP0WL/oNOcd8tc0oNemY93Ry+VHfC7Yp26OMVLS8ucJRh7dnEh3ywvsjL0gAAAxAAAAAAAAAA=="
        }
    ],
    "x509SigningCert": "MIAGCSqGSIb3DQEHAqCAMIACAQExADALBgkqhkiG9w0BBwGggDCCBWswggNToAMCAQICFEPudg2y03FF8RqPNfDpiNjH721AMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNVBAYTAlVTMRMwEQYDVQQIDApTb21lLVN0YXRlMSEwHwYDVQQKDBhJbnRlcm5ldCBXaWRnaXRzIFB0eSBMdGQwHhcNMjYwNzMwMTUwNDUwWhcNMjcwNzMwMTUwNDUwWjBFMQswCQYDVQQGEwJVUzETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAyKX5HhQiVU+rqpBEW+b/yPX/rH34FyJvhcZwj4jQhD74q22bEKW8P5mdHshTYIGyNqhcu+P6LlXr+IJWN8XQyaKE83yjqpGODrQY9rgFbft2WH264Xtaow9YA9eeJSomPTZ96CmGIr4+SesWoFQdre1CXNUwr5HMEYW0hPdR7fDNVoEHfDYZWzeSeLllJ+JLoqoX5YiiAJKw9Kz6eOeqs1Ln4qL7PNwF2l4xgLwT4Am4B0kQH8MavBHZUvzoaDk8ygEGDsub0IbSSprEET0mlOOThp9euhL9fYUES/EA63fv1ZXMVQAQuLMYqD4iWctW/7d1XE3ckSoqk7s6/+WYufREdANBMez++c59e8s5KeYqmse01btuV/GAnP244ijOqxC4bW04p9RSggvkN5qBxCjx1GbtGwvIHRdRT0NKmAzq537rq/y4FV9AFBvoR5yc2iZR1O0qCrszZ1V1sVTyOCFWnETTRmYgQDkYxcP2cC3fXDha6Nz22T4pranz+1z5Huj0l4SOO3+OMXiPnOxZMDRxA1GISAwVbh6h38PC/tudUwyzvum1oNb/9fHJkLY7Iywxkplngo4juWwamGU6hzuxjT7V3Gc0PhiNl072C95LhxDUkmzb0ywfw2w0GovvPNRITGElgJzAY2mCVlOt+zSdwvCON1O61iHCFAOiQ4MCAwEAAaNTMFEwHQYDVR0OBBYEFGx0QdpahDHNaPtg6xRj6XVcXd/jMB8GA1UdIwQYMBaAFGx0QdpahDHNaPtg6xRj6XVcXd/jMA8GA1UdEwEB/wQFMAMBAf8wDQYJKoZIhvcNAQELBQADggIBAE4WO1d0AHPKzEHRslQnxnFJzqPF7XJUw1iUX9B8DpflhscLQL0SWiIbXCFhpMXrRzorCkRZNJ09LS+D1ql6MwPjqlVhTgqTvrRWiquvTeaIpsa39KpdbJ23+rVTqzpjugJgtu9XXmXFak7YbTXkOPts9KnDVEPd1zNfmDp6xA8pdKyf3Oxorj8iDOIofXw734zSKT4XNmgs41d9SGlUKMuHypgE1vIdX53BRZxsJ9E27rewfNfwSxtfaXvb8xKlo5QuSavkrM0EZV+rwYcvpCvlTLTFoNab1PEpmqjiAzrv2ClpCXFoDy6lqIipsfSBXARuxqTHwOmrKXEUuyyDhuaZVMdVhz0bPr/t0cl+gf2yvnXff+yXoTcR/F09B5oaA5PfKYryoINSuYDKDztp2BSFumm4owlRhqYFodBAfJOgyhQv116UjBFuSYDNGnn235JmNFWMEIewo+XjXo2sMx6jecz7D4t66JKouIenWaCsWSORonoAIWja9fhqsHaCJLstXhBwPaTZWRv5/FKaDI+gIwS3fkOhUdU+Xm4TxlvGXchimz6sBj21NhseMwDb9vCps1+Qq3+Yn9ZF3MrMIYOieS0QKrVKbWjLQPjQy0kl6yOg4gP0WL/oNOcd8tc0oNemY93Ry+VHfC7Yp26OMVLS8ucJRh7dnEh3ywvsjL0gAAAxAAAAAAAAAA=="
}