Step 1: Create a single-page application

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

You can use the POST {{apiPath}}/environments/{{envID}}/applications endpoint to create the new single-page application. The application’s protocol property is required, and in this example it specifies an OPENID_CONNECT application.

The response data returns information about the new application, including its id property, which identifies the UUID for this application resource. The application’s ID is required in Step 8 to make the authorization request.

Headers

Authorization Bearer {{accessToken}}

Content-Type application/json

Body

raw ( application/json )

{
    "enabled": true,
    "name": "Single-Page-App_{{$timestamp}}",
    "description": "A Single Page App",
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "grantTypes": [
        "IMPLICIT"
    ],
    "redirectUris": [
        "https://www.google.com"
    ],
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "tokenEndpointAuthMethod": "NONE",
    "refreshTokenDuration": 86400,
    "refreshTokenRollingDuration": 86400
}

Example Request

curl --location --globoff '{{apiPath}}/environments/{{envID}}/applications' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "enabled": true,
    "name": "Single-Page-App_{{$timestamp}}",
    "description": "A Single Page App",
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "grantTypes": [
        "IMPLICIT"
    ],
    "redirectUris": [
        "https://www.google.com"
    ],
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "tokenEndpointAuthMethod": "NONE",
    "refreshTokenDuration": 86400,
    "refreshTokenRollingDuration": 86400
}'

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" +
@"    ""enabled"": true," + "\n" +
@"    ""name"": ""Single-Page-App_{{$timestamp}}""," + "\n" +
@"    ""description"": ""A Single Page App""," + "\n" +
@"    ""type"": ""SINGLE_PAGE_APP""," + "\n" +
@"    ""protocol"": ""OPENID_CONNECT""," + "\n" +
@"    ""grantTypes"": [" + "\n" +
@"        ""IMPLICIT""" + "\n" +
@"    ]," + "\n" +
@"    ""redirectUris"": [" + "\n" +
@"        ""https://www.google.com""" + "\n" +
@"    ]," + "\n" +
@"    ""responseTypes"": [" + "\n" +
@"        ""TOKEN""," + "\n" +
@"        ""ID_TOKEN""" + "\n" +
@"    ]," + "\n" +
@"    ""tokenEndpointAuthMethod"": ""NONE""," + "\n" +
@"    ""refreshTokenDuration"": 86400," + "\n" +
@"    ""refreshTokenRollingDuration"": 86400" + "\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(`{
    "enabled": true,
    "name": "Single-Page-App_{{$timestamp}}",
    "description": "A Single Page App",
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "grantTypes": [
        "IMPLICIT"
    ],
    "redirectUris": [
        "https://www.google.com"
    ],
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "tokenEndpointAuthMethod": "NONE",
    "refreshTokenDuration": 86400,
    "refreshTokenRollingDuration": 86400
}`)

  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}}

{
    "enabled": true,
    "name": "Single-Page-App_{{$timestamp}}",
    "description": "A Single Page App",
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "grantTypes": [
        "IMPLICIT"
    ],
    "redirectUris": [
        "https://www.google.com"
    ],
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "tokenEndpointAuthMethod": "NONE",
    "refreshTokenDuration": 86400,
    "refreshTokenRollingDuration": 86400
}

OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"enabled\": true,\n    \"name\": \"Single-Page-App_{{$timestamp}}\",\n    \"description\": \"A Single Page App\",\n    \"type\": \"SINGLE_PAGE_APP\",\n    \"protocol\": \"OPENID_CONNECT\",\n    \"grantTypes\": [\n        \"IMPLICIT\"\n    ],\n    \"redirectUris\": [\n        \"https://www.google.com\"\n    ],\n    \"responseTypes\": [\n        \"TOKEN\",\n        \"ID_TOKEN\"\n    ],\n    \"tokenEndpointAuthMethod\": \"NONE\",\n    \"refreshTokenDuration\": 86400,\n    \"refreshTokenRollingDuration\": 86400\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({
    "enabled": true,
    "name": "Single-Page-App_{{$timestamp}}",
    "description": "A Single Page App",
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "grantTypes": [
      "IMPLICIT"
    ],
    "redirectUris": [
      "https://www.google.com"
    ],
    "responseTypes": [
      "TOKEN",
      "ID_TOKEN"
    ],
    "tokenEndpointAuthMethod": "NONE",
    "refreshTokenDuration": 86400,
    "refreshTokenRollingDuration": 86400
  }),
};

$.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({
    "enabled": true,
    "name": "Single-Page-App_{{$timestamp}}",
    "description": "A Single Page App",
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "grantTypes": [
      "IMPLICIT"
    ],
    "redirectUris": [
      "https://www.google.com"
    ],
    "responseTypes": [
      "TOKEN",
      "ID_TOKEN"
    ],
    "tokenEndpointAuthMethod": "NONE",
    "refreshTokenDuration": 86400,
    "refreshTokenRollingDuration": 86400
  })

};
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({
  "enabled": True,
  "name": "Single-Page-App_{{$timestamp}}",
  "description": "A Single Page App",
  "type": "SINGLE_PAGE_APP",
  "protocol": "OPENID_CONNECT",
  "grantTypes": [
    "IMPLICIT"
  ],
  "redirectUris": [
    "https://www.google.com"
  ],
  "responseTypes": [
    "TOKEN",
    "ID_TOKEN"
  ],
  "tokenEndpointAuthMethod": "NONE",
  "refreshTokenDuration": 86400,
  "refreshTokenRollingDuration": 86400
})
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    "enabled": true,\n    "name": "Single-Page-App_{{$timestamp}}",\n    "description": "A Single Page App",\n    "type": "SINGLE_PAGE_APP",\n    "protocol": "OPENID_CONNECT",\n    "grantTypes": [\n        "IMPLICIT"\n    ],\n    "redirectUris": [\n        "https://www.google.com"\n    ],\n    "responseTypes": [\n        "TOKEN",\n        "ID_TOKEN"\n    ],\n    "tokenEndpointAuthMethod": "NONE",\n    "refreshTokenDuration": 86400,\n    "refreshTokenRollingDuration": 86400\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({
  "enabled": true,
  "name": "Single-Page-App_{{\$timestamp}}",
  "description": "A Single Page App",
  "type": "SINGLE_PAGE_APP",
  "protocol": "OPENID_CONNECT",
  "grantTypes": [
    "IMPLICIT"
  ],
  "redirectUris": [
    "https://www.google.com"
  ],
  "responseTypes": [
    "TOKEN",
    "ID_TOKEN"
  ],
  "tokenEndpointAuthMethod": "NONE",
  "refreshTokenDuration": 86400,
  "refreshTokenRollingDuration": 86400
})

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

let parameters = "{\n    \"enabled\": true,\n    \"name\": \"Single-Page-App_{{$timestamp}}\",\n    \"description\": \"A Single Page App\",\n    \"type\": \"SINGLE_PAGE_APP\",\n    \"protocol\": \"OPENID_CONNECT\",\n    \"grantTypes\": [\n        \"IMPLICIT\"\n    ],\n    \"redirectUris\": [\n        \"https://www.google.com\"\n    ],\n    \"responseTypes\": [\n        \"TOKEN\",\n        \"ID_TOKEN\"\n    ],\n    \"tokenEndpointAuthMethod\": \"NONE\",\n    \"refreshTokenDuration\": 86400,\n    \"refreshTokenRollingDuration\": 86400\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/13bcad4a-fd08-46da-9e32-2d923e73542a"
        },
        "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/13bcad4a-fd08-46da-9e32-2d923e73542a/attributes"
        },
        "secret": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/13bcad4a-fd08-46da-9e32-2d923e73542a/secret"
        },
        "grants": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/13bcad4a-fd08-46da-9e32-2d923e73542a/grants"
        }
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "id": "13bcad4a-fd08-46da-9e32-2d923e73542a",
    "name": "Single-Page-App_1627057132",
    "description": "A Single Page App",
    "enabled": true,
    "type": "SINGLE_PAGE_APP",
    "protocol": "OPENID_CONNECT",
    "createdAt": "2021-07-23T16:18:52.033Z",
    "updatedAt": "2021-07-23T16:18:52.033Z",
    "assignActorRoles": false,
    "responseTypes": [
        "ID_TOKEN",
        "TOKEN"
    ],
    "grantTypes": [
        "IMPLICIT"
    ],
    "refreshTokenDuration": 86400,
    "tokenEndpointAuthMethod": "NONE",
    "pkceEnforcement": "OPTIONAL",
    "refreshTokenRollingDuration": 86400,
    "redirectUris": [
        "https://www.google.com"
    ]
}

PingOne Platform APIs

Step 1: Create a single-page application

Headers

Body

Example Request

Example Response