CREATE Template
POST {{baseUrl}}/api/v1/templates
The POST /api/v1/templates endpoint adds a new OAuth, OIDC, SAML, or PingAccess template.
Body
raw ( application/json )
{
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<string>"
}
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{baseUrl}}/api/v1/templates' \
--header 'Cookie: <string>' \
--header 'X-XSRF-Header: PASS' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==' \
--data '{
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<string>"
}'
var options = new RestClientOptions("{{baseUrl}}/api/v1/templates")
{
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" +
@" ""environmentId"": ""<string>""," + "\n" +
@" ""name"": ""<string>""," + "\n" +
@" ""type"": ""<string>""," + "\n" +
@" ""created"": ""<dateTime>""," + "\n" +
@" ""description"": ""<string>""," + "\n" +
@" ""icon"": ""<string>""," + "\n" +
@" ""id"": ""<string>""," + "\n" +
@" ""modified"": ""<dateTime>""," + "\n" +
@" ""pingcentralVersionAtCreation"": ""<string>""," + "\n" +
@" ""revisionSummaryViews"": [" + "\n" +
@" {" + "\n" +
@" ""modified"": ""<dateTime>""," + "\n" +
@" ""modifiedBy"": ""<string>""," + "\n" +
@" ""revisionNumber"": ""<int>""," + "\n" +
@" ""updateTemplateComment"": ""<string>""" + "\n" +
@" }" + "\n" +
@" ]," + "\n" +
@" ""updateTemplateComment"": ""<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/templates"
method := "POST"
payload := strings.NewReader(`{
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<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/templates HTTP/1.1
Host: {{baseUrl}}
Cookie: <string>
X-XSRF-Header: PASS
Content-Type: application/json
Authorization: Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ==
{
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<string>"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"environmentId\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"created\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"pingcentralVersionAtCreation\": \"<string>\",\n \"revisionSummaryViews\": [\n {\n \"modified\": \"<dateTime>\",\n \"modifiedBy\": \"<string>\",\n \"revisionNumber\": \"<int>\",\n \"updateTemplateComment\": \"<string>\"\n }\n ],\n \"updateTemplateComment\": \"<string>\"\n}");
Request request = new Request.Builder()
.url("{{baseUrl}}/api/v1/templates")
.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/templates",
"method": "POST",
"timeout": 0,
"headers": {
"Cookie": "<string>",
"X-XSRF-Header": "PASS",
"Content-Type": "application/json",
"Authorization": "Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=="
},
"data": JSON.stringify({
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<string>"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{baseUrl}}/api/v1/templates',
'headers': {
'Cookie': '<string>',
'X-XSRF-Header': 'PASS',
'Content-Type': 'application/json',
'Authorization': 'Basic e3t1c2VybmFtZX19Ont7cGFzc3dvcmR9fQ=='
},
body: JSON.stringify({
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<string>"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{baseUrl}}/api/v1/templates"
payload = json.dumps({
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<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/templates');
$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 "environmentId": "<string>",\n "name": "<string>",\n "type": "<string>",\n "created": "<dateTime>",\n "description": "<string>",\n "icon": "<string>",\n "id": "<string>",\n "modified": "<dateTime>",\n "pingcentralVersionAtCreation": "<string>",\n "revisionSummaryViews": [\n {\n "modified": "<dateTime>",\n "modifiedBy": "<string>",\n "revisionNumber": "<int>",\n "updateTemplateComment": "<string>"\n }\n ],\n "updateTemplateComment": "<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/templates")
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({
"environmentId": "<string>",
"name": "<string>",
"type": "<string>",
"created": "<dateTime>",
"description": "<string>",
"icon": "<string>",
"id": "<string>",
"modified": "<dateTime>",
"pingcentralVersionAtCreation": "<string>",
"revisionSummaryViews": [
{
"modified": "<dateTime>",
"modifiedBy": "<string>",
"revisionNumber": "<int>",
"updateTemplateComment": "<string>"
}
],
"updateTemplateComment": "<string>"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"environmentId\": \"<string>\",\n \"name\": \"<string>\",\n \"type\": \"<string>\",\n \"created\": \"<dateTime>\",\n \"description\": \"<string>\",\n \"icon\": \"<string>\",\n \"id\": \"<string>\",\n \"modified\": \"<dateTime>\",\n \"pingcentralVersionAtCreation\": \"<string>\",\n \"revisionSummaryViews\": [\n {\n \"modified\": \"<dateTime>\",\n \"modifiedBy\": \"<string>\",\n \"revisionNumber\": \"<int>\",\n \"updateTemplateComment\": \"<string>\"\n }\n ],\n \"updateTemplateComment\": \"<string>\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{baseUrl}}/api/v1/templates")!,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
201 Created
{
"created": "2020-12-03T12:52:25.973290Z",
"description": "Description of the template.",
"environmentId": "8c5af57e-f665-4c3e-948f-d30f75cfb69c",
"icon": "cog",
"id": "3c0c3547-b2c5-4536-8566-dad1da81cbf6",
"modified": "2020-12-03T12:52:25.973290Z",
"name": "Template Name",
"pingcentralVersionAtCreation": "1.6.0",
"type": "OAuth",
"revisionSummaryViews": [
{
"modified": "2020-12-03T12:52:25.973290Z",
"modifiedBy": "administrator",
"revisionNumber": 1,
"updateTemplateComment": "Updated to include a new grant type."
}
],
"updateTemplateComment": "Updated to include a new grant type."
}