Step 3: Create a SAML application in the source environment

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

Create a SAML application in the source environment using a POST {{apiPath}}/environments/{{SourceEnvID}}/applications request.

The application name must be unique to the environment.
The acsUrls entry must contain the destination environment ID. Use the authentication path extension for your region, such as auth.pingone.eu or auth.pingone.com. For example, https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs.
The spEntityId value must be unique to the environment and is also used as the spEntityId value when you create an IdP for the destination environment in a subsequent step.
Set assertionDuration to 300 seconds.
Set the idpSigningKey ID value to the key that you copied in a previous step.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/json

Body

raw ( application/json )

{
    "name": "saml-test-apps_{{$timestamp}}",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "assertionSigned": true,
    "assertionDuration": 300,
    "acsUrls": [
        "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
    ],
    "spEntityId": "samlTests_{{$timestamp}}",
    "idpSigning": {
        "key": {
            "id": "{{keyID}}"
        },
        "algorithm": "SHA256withRSA"
    }
}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/applications' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "saml-test-apps_{{$timestamp}}",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "assertionSigned": true,
    "assertionDuration": 300,
    "acsUrls": [
        "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
    ],
    "spEntityId": "samlTests_{{$timestamp}}",
    "idpSigning": {
        "key": {
            "id": "{{keyID}}"
        },
        "algorithm": "SHA256withRSA"
    }
}'

var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/applications")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@"    ""name"": ""saml-test-apps_{{$timestamp}}""," + "\n" +
@"    ""description"": ""saml test source application""," + "\n" +
@"    ""enabled"": true," + "\n" +
@"    ""type"": ""WEB_APP""," + "\n" +
@"    ""protocol"": ""SAML""," + "\n" +
@"    ""assertionSigned"": true," + "\n" +
@"    ""assertionDuration"": 300," + "\n" +
@"    ""acsUrls"": [" + "\n" +
@"        ""https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs""" + "\n" +
@"    ]," + "\n" +
@"    ""spEntityId"": ""samlTests_{{$timestamp}}""," + "\n" +
@"    ""idpSigning"": {" + "\n" +
@"        ""key"": {" + "\n" +
@"            ""id"": ""{{keyID}}""" + "\n" +
@"        }," + "\n" +
@"        ""algorithm"": ""SHA256withRSA""" + "\n" +
@"    }" + "\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 := "{{apiPath}}/environments/{{envID}}/applications"
  method := "POST"

  payload := strings.NewReader(`{
    "name": "saml-test-apps_{{$timestamp}}",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "assertionSigned": true,
    "assertionDuration": 300,
    "acsUrls": [
        "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
    ],
    "spEntityId": "samlTests_{{$timestamp}}",
    "idpSigning": {
        "key": {
            "id": "{{keyID}}"
        },
        "algorithm": "SHA256withRSA"
    }
}`)

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

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

{
    "name": "saml-test-apps_{{$timestamp}}",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "assertionSigned": true,
    "assertionDuration": 300,
    "acsUrls": [
        "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
    ],
    "spEntityId": "samlTests_{{$timestamp}}",
    "idpSigning": {
        "key": {
            "id": "{{keyID}}"
        },
        "algorithm": "SHA256withRSA"
    }
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"saml-test-apps_{{$timestamp}}\",\n    \"description\": \"saml test source application\",\n    \"enabled\": true,\n    \"type\": \"WEB_APP\",\n    \"protocol\": \"SAML\",\n    \"assertionSigned\": true,\n    \"assertionDuration\": 300,\n    \"acsUrls\": [\n        \"https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs\"\n    ],\n    \"spEntityId\": \"samlTests_{{$timestamp}}\",\n    \"idpSigning\": {\n        \"key\": {\n            \"id\": \"{{keyID}}\"\n        },\n        \"algorithm\": \"SHA256withRSA\"\n    }\n}");
Request request = new Request.Builder()
  .url("{{apiPath}}/environments/{{envID}}/applications")
  .method("POST", body)
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer {{accessToken}}")
  .build();
Response response = client.newCall(request).execute();

var settings = {
  "url": "{{apiPath}}/environments/{{envID}}/applications",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Content-Type": "application/json",
    "Authorization": "Bearer {{accessToken}}"
  },
  "data": JSON.stringify({
    "name": "saml-test-apps_{{$timestamp}}",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "assertionSigned": true,
    "assertionDuration": 300,
    "acsUrls": [
      "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
    ],
    "spEntityId": "samlTests_{{$timestamp}}",
    "idpSigning": {
      "key": {
        "id": "{{keyID}}"
      },
      "algorithm": "SHA256withRSA"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{apiPath}}/environments/{{envID}}/applications',
  'headers': {
    'Content-Type': 'application/json',
    'Authorization': 'Bearer {{accessToken}}'
  },
  body: JSON.stringify({
    "name": "saml-test-apps_{{$timestamp}}",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "assertionSigned": true,
    "assertionDuration": 300,
    "acsUrls": [
      "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
    ],
    "spEntityId": "samlTests_{{$timestamp}}",
    "idpSigning": {
      "key": {
        "id": "{{keyID}}"
      },
      "algorithm": "SHA256withRSA"
    }
  })

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

import requests
import json

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

payload = json.dumps({
  "name": "saml-test-apps_{{$timestamp}}",
  "description": "saml test source application",
  "enabled": True,
  "type": "WEB_APP",
  "protocol": "SAML",
  "assertionSigned": True,
  "assertionDuration": 300,
  "acsUrls": [
    "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
  ],
  "spEntityId": "samlTests_{{$timestamp}}",
  "idpSigning": {
    "key": {
      "id": "{{keyID}}"
    },
    "algorithm": "SHA256withRSA"
  }
})
headers = {
  'Content-Type': '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}}/environments/{{envID}}/applications');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'Content-Type' => 'application/json',
  'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n    "name": "saml-test-apps_{{$timestamp}}",\n    "description": "saml test source application",\n    "enabled": true,\n    "type": "WEB_APP",\n    "protocol": "SAML",\n    "assertionSigned": true,\n    "assertionDuration": 300,\n    "acsUrls": [\n        "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"\n    ],\n    "spEntityId": "samlTests_{{$timestamp}}",\n    "idpSigning": {\n        "key": {\n            "id": "{{keyID}}"\n        },\n        "algorithm": "SHA256withRSA"\n    }\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("{{apiPath}}/environments/{{envID}}/applications")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
  "name": "saml-test-apps_{{\$timestamp}}",
  "description": "saml test source application",
  "enabled": true,
  "type": "WEB_APP",
  "protocol": "SAML",
  "assertionSigned": true,
  "assertionDuration": 300,
  "acsUrls": [
    "https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs"
  ],
  "spEntityId": "samlTests_{{\$timestamp}}",
  "idpSigning": {
    "key": {
      "id": "{{keyID}}"
    },
    "algorithm": "SHA256withRSA"
  }
})

response = http.request(request)
puts response.read_body

let parameters = "{\n    \"name\": \"saml-test-apps_{{$timestamp}}\",\n    \"description\": \"saml test source application\",\n    \"enabled\": true,\n    \"type\": \"WEB_APP\",\n    \"protocol\": \"SAML\",\n    \"assertionSigned\": true,\n    \"assertionDuration\": 300,\n    \"acsUrls\": [\n        \"https://auth.pingone.com/{{destinationEnvID}}/saml20/sp/acs\"\n    ],\n    \"spEntityId\": \"samlTests_{{$timestamp}}\",\n    \"idpSigning\": {\n        \"key\": {\n            \"id\": \"{{keyID}}\"\n        },\n        \"algorithm\": \"SHA256withRSA\"\n    }\n}"
let postData = parameters.data(using: .utf8)

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

201 Created

{
    "_links": {
        "self": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/60aa61b7-fe3e-4a86-a2e1-4924e7feaf96"
        },
        "environment": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
        },
        "attributes": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/60aa61b7-fe3e-4a86-a2e1-4924e7feaf96/attributes"
        },
        "idpSigningKey": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/keys/cf21b465-c2eb-431e-a092-98a4d8bc8d7a"
        }
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "id": "60aa61b7-fe3e-4a86-a2e1-4924e7feaf96",
    "name": "saml-test-app",
    "description": "saml test source application",
    "enabled": true,
    "type": "WEB_APP",
    "protocol": "SAML",
    "createdAt": "2020-11-03T17:59:23.631Z",
    "updatedAt": "2020-11-03T17:59:23.631Z",
    "assignActorRoles": false,
    "spEntityId": "samlTest",
    "responseSigned": false,
    "sloBinding": "HTTP_POST",
    "acsUrls": [
        "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/saml20/sp/acs"
    ],
    "assertionDuration": 300,
    "assertionSigned": true,
    "idpSigning": {
        "key": {
            "id": "cf21b465-c2eb-431e-a092-98a4d8bc8d7a"
        },
        "algorithm": "SHA256withRSA"
    }
}

PingOne Platform APIs

Step 3: Create a SAML application in the source environment

Headers

Body

Example Request

Example Response