PingOne Platform APIs

Create Application (OIDC Mobile App)

   

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

The POST {{apiPath}}/environments/{{envID}}/applications operation adds a new native application resource to the specified environment.

The sample POST operation shows usage of the optional bundleId and packageName properties, for adding a new NATIVE_APP type resource (a native application) to the specified environment.

Prerequisites

Request Model

Base application data model (native application)

Refer to Applications base data model for complete descriptions.

Property Required? Type

assignActorRoles

Optional

Boolean

accessControl.role.type

Optional

String

accessControl.group.type

Optional

String

accessControl.group.groups

Optional

Array

accessControl.group.groups.id

Optional

UUID

description

Optional

String

enabled

Required

Boolean

homePageUrl

Optional

URL

loginPageUrl

Optional

URL

icon.id

Optional

UUID

icon.href

Optional

URL

name

Required

String

protocol

Required

String

tags

Optional

Array

type

Required

String

Additional OIDC settings

Refer to Applications OIDC settings data model for complete descriptions.

If you set the protocol attribute to OPENID_CONNECT, you must provide values for the required OIDC settings. Optional settings can be omitted.

Property Required? Type

additionalRefreshTokenReplayProtectionEnabled

Optional

Boolean

grantTypes

Optional

String

jwks

String

Optional

jwksUrl

String

Optional

pkceEnforcement

Optional

String

pkceEnforcement

Optional

String

postLogoutRedirectUris

Required

URL

redirectUris

Required

URL

refreshTokenDuration

Optional

Integer

refreshTokenRollingDuration

Optional

Integer

requireSignedRequestObject

Optional

Boolean

responseTypes

Required

String

signing

Optional

Object

signing.keyRotationPolicy

Required

Object

signing.keyRotationPolicy.id

Required

String

supportUnsignedRequestObject

Optional

Boolean

tokenEndpointAuthMethod

Required

String

Additional NATIVE_APP settings

If you set the type attribute to NATIVE_APP, you can also set the following optional properties.

Property Required? Type

bundleId

N

String

mobile.bundleId

N

String

mobile.packageName

N

String

mobile.integrityDetection.mode

N

String

mobile.integrityDetection.cacheDuration.amount

N

Integer

mobile.integrityDetection.cacheDuration.units

N

String

packageName

N

String

Headers

Authorization      Bearer {{accessToken}}

Content-Type      application/json

Body

raw ( application/json )

{
    "name": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "grantTypes": [
        "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "postLogoutRedirectUris": [
        "https://example.com"
    ],
    "redirectUris": [
        "https://example.com:3000/response",
        "https://example.com:3000/code/response",
        "https://example.com"
    ],
    "mobile": {
        "bundleId": "com.pingidentity.bundleId",
        "packageName": "com.pingidentity.packageName",
        "integrityDetection": {
            "mode": "DISABLED"
        },
        "passcodeRefreshDuration": {
            "duration": 30,
            "timeUnit": "SECONDS"
        }
    }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{apiPath}}/environments/{{envID}}/applications' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
    "name": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "grantTypes": [
        "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "postLogoutRedirectUris": [
        "https://example.com"
    ],
    "redirectUris": [
        "https://example.com:3000/response",
        "https://example.com:3000/code/response",
        "https://example.com"
    ],
    "mobile": {
        "bundleId": "com.pingidentity.bundleId",
        "packageName": "com.pingidentity.packageName",
        "integrityDetection": {
            "mode": "DISABLED"
        },
        "passcodeRefreshDuration": {
            "duration": 30,
            "timeUnit": "SECONDS"
        }
    }
}'
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"": ""SALES APPLICATION""," + "\n" +
@"    ""description"": ""Description for my sales application.""," + "\n" +
@"    ""enabled"": true," + "\n" +
@"    ""type"": ""NATIVE_APP""," + "\n" +
@"    ""loginPageUrl"": ""https://example.com""," + "\n" +
@"    ""protocol"": ""OPENID_CONNECT""," + "\n" +
@"    ""responseTypes"": [" + "\n" +
@"        ""TOKEN""," + "\n" +
@"        ""ID_TOKEN""" + "\n" +
@"    ]," + "\n" +
@"    ""grantTypes"": [" + "\n" +
@"        ""IMPLICIT""" + "\n" +
@"    ]," + "\n" +
@"    ""tokenEndpointAuthMethod"": ""CLIENT_SECRET_BASIC""," + "\n" +
@"    ""postLogoutRedirectUris"": [" + "\n" +
@"        ""https://example.com""" + "\n" +
@"    ]," + "\n" +
@"    ""redirectUris"": [" + "\n" +
@"        ""https://example.com:3000/response""," + "\n" +
@"        ""https://example.com:3000/code/response""," + "\n" +
@"        ""https://example.com""" + "\n" +
@"    ]," + "\n" +
@"    ""mobile"": {" + "\n" +
@"        ""bundleId"": ""com.pingidentity.bundleId""," + "\n" +
@"        ""packageName"": ""com.pingidentity.packageName""," + "\n" +
@"        ""integrityDetection"": {" + "\n" +
@"            ""mode"": ""DISABLED""" + "\n" +
@"        }," + "\n" +
@"        ""passcodeRefreshDuration"": {" + "\n" +
@"            ""duration"": 30," + "\n" +
@"            ""timeUnit"": ""SECONDS""" + "\n" +
@"        }" + "\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": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "grantTypes": [
        "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "postLogoutRedirectUris": [
        "https://example.com"
    ],
    "redirectUris": [
        "https://example.com:3000/response",
        "https://example.com:3000/code/response",
        "https://example.com"
    ],
    "mobile": {
        "bundleId": "com.pingidentity.bundleId",
        "packageName": "com.pingidentity.packageName",
        "integrityDetection": {
            "mode": "DISABLED"
        },
        "passcodeRefreshDuration": {
            "duration": 30,
            "timeUnit": "SECONDS"
        }
    }
}`)

  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": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "responseTypes": [
        "TOKEN",
        "ID_TOKEN"
    ],
    "grantTypes": [
        "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "postLogoutRedirectUris": [
        "https://example.com"
    ],
    "redirectUris": [
        "https://example.com:3000/response",
        "https://example.com:3000/code/response",
        "https://example.com"
    ],
    "mobile": {
        "bundleId": "com.pingidentity.bundleId",
        "packageName": "com.pingidentity.packageName",
        "integrityDetection": {
            "mode": "DISABLED"
        },
        "passcodeRefreshDuration": {
            "duration": 30,
            "timeUnit": "SECONDS"
        }
    }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n    \"name\": \"SALES APPLICATION\",\n    \"description\": \"Description for my sales application.\",\n    \"enabled\": true,\n    \"type\": \"NATIVE_APP\",\n    \"loginPageUrl\": \"https://example.com\",\n    \"protocol\": \"OPENID_CONNECT\",\n    \"responseTypes\": [\n        \"TOKEN\",\n        \"ID_TOKEN\"\n    ],\n    \"grantTypes\": [\n        \"IMPLICIT\"\n    ],\n    \"tokenEndpointAuthMethod\": \"CLIENT_SECRET_BASIC\",\n    \"postLogoutRedirectUris\": [\n        \"https://example.com\"\n    ],\n    \"redirectUris\": [\n        \"https://example.com:3000/response\",\n        \"https://example.com:3000/code/response\",\n        \"https://example.com\"\n    ],\n    \"mobile\": {\n        \"bundleId\": \"com.pingidentity.bundleId\",\n        \"packageName\": \"com.pingidentity.packageName\",\n        \"integrityDetection\": {\n            \"mode\": \"DISABLED\"\n        },\n        \"passcodeRefreshDuration\": {\n            \"duration\": 30,\n            \"timeUnit\": \"SECONDS\"\n        }\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": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "responseTypes": [
      "TOKEN",
      "ID_TOKEN"
    ],
    "grantTypes": [
      "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "postLogoutRedirectUris": [
      "https://example.com"
    ],
    "redirectUris": [
      "https://example.com:3000/response",
      "https://example.com:3000/code/response",
      "https://example.com"
    ],
    "mobile": {
      "bundleId": "com.pingidentity.bundleId",
      "packageName": "com.pingidentity.packageName",
      "integrityDetection": {
        "mode": "DISABLED"
      },
      "passcodeRefreshDuration": {
        "duration": 30,
        "timeUnit": "SECONDS"
      }
    }
  }),
};

$.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": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "responseTypes": [
      "TOKEN",
      "ID_TOKEN"
    ],
    "grantTypes": [
      "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "postLogoutRedirectUris": [
      "https://example.com"
    ],
    "redirectUris": [
      "https://example.com:3000/response",
      "https://example.com:3000/code/response",
      "https://example.com"
    ],
    "mobile": {
      "bundleId": "com.pingidentity.bundleId",
      "packageName": "com.pingidentity.packageName",
      "integrityDetection": {
        "mode": "DISABLED"
      },
      "passcodeRefreshDuration": {
        "duration": 30,
        "timeUnit": "SECONDS"
      }
    }
  })

};
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": "SALES APPLICATION",
  "description": "Description for my sales application.",
  "enabled": True,
  "type": "NATIVE_APP",
  "loginPageUrl": "https://example.com",
  "protocol": "OPENID_CONNECT",
  "responseTypes": [
    "TOKEN",
    "ID_TOKEN"
  ],
  "grantTypes": [
    "IMPLICIT"
  ],
  "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
  "postLogoutRedirectUris": [
    "https://example.com"
  ],
  "redirectUris": [
    "https://example.com:3000/response",
    "https://example.com:3000/code/response",
    "https://example.com"
  ],
  "mobile": {
    "bundleId": "com.pingidentity.bundleId",
    "packageName": "com.pingidentity.packageName",
    "integrityDetection": {
      "mode": "DISABLED"
    },
    "passcodeRefreshDuration": {
      "duration": 30,
      "timeUnit": "SECONDS"
    }
  }
})
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": "SALES APPLICATION",\n    "description": "Description for my sales application.",\n    "enabled": true,\n    "type": "NATIVE_APP",\n    "loginPageUrl": "https://example.com",\n    "protocol": "OPENID_CONNECT",\n    "responseTypes": [\n        "TOKEN",\n        "ID_TOKEN"\n    ],\n    "grantTypes": [\n        "IMPLICIT"\n    ],\n    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",\n    "postLogoutRedirectUris": [\n        "https://example.com"\n    ],\n    "redirectUris": [\n        "https://example.com:3000/response",\n        "https://example.com:3000/code/response",\n        "https://example.com"\n    ],\n    "mobile": {\n        "bundleId": "com.pingidentity.bundleId",\n        "packageName": "com.pingidentity.packageName",\n        "integrityDetection": {\n            "mode": "DISABLED"\n        },\n        "passcodeRefreshDuration": {\n            "duration": 30,\n            "timeUnit": "SECONDS"\n        }\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": "SALES APPLICATION",
  "description": "Description for my sales application.",
  "enabled": true,
  "type": "NATIVE_APP",
  "loginPageUrl": "https://example.com",
  "protocol": "OPENID_CONNECT",
  "responseTypes": [
    "TOKEN",
    "ID_TOKEN"
  ],
  "grantTypes": [
    "IMPLICIT"
  ],
  "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
  "postLogoutRedirectUris": [
    "https://example.com"
  ],
  "redirectUris": [
    "https://example.com:3000/response",
    "https://example.com:3000/code/response",
    "https://example.com"
  ],
  "mobile": {
    "bundleId": "com.pingidentity.bundleId",
    "packageName": "com.pingidentity.packageName",
    "integrityDetection": {
      "mode": "DISABLED"
    },
    "passcodeRefreshDuration": {
      "duration": 30,
      "timeUnit": "SECONDS"
    }
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n    \"name\": \"SALES APPLICATION\",\n    \"description\": \"Description for my sales application.\",\n    \"enabled\": true,\n    \"type\": \"NATIVE_APP\",\n    \"loginPageUrl\": \"https://example.com\",\n    \"protocol\": \"OPENID_CONNECT\",\n    \"responseTypes\": [\n        \"TOKEN\",\n        \"ID_TOKEN\"\n    ],\n    \"grantTypes\": [\n        \"IMPLICIT\"\n    ],\n    \"tokenEndpointAuthMethod\": \"CLIENT_SECRET_BASIC\",\n    \"postLogoutRedirectUris\": [\n        \"https://example.com\"\n    ],\n    \"redirectUris\": [\n        \"https://example.com:3000/response\",\n        \"https://example.com:3000/code/response\",\n        \"https://example.com\"\n    ],\n    \"mobile\": {\n        \"bundleId\": \"com.pingidentity.bundleId\",\n        \"packageName\": \"com.pingidentity.packageName\",\n        \"integrityDetection\": {\n            \"mode\": \"DISABLED\"\n        },\n        \"passcodeRefreshDuration\": {\n            \"duration\": 30,\n            \"timeUnit\": \"SECONDS\"\n        }\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/6b0eee9c-6dc1-42fb-85cd-018753d72161"
        },
        "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/6b0eee9c-6dc1-42fb-85cd-018753d72161/attributes"
        },
        "pushCredentials": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/6b0eee9c-6dc1-42fb-85cd-018753d72161/pushCredentials"
        },
        "secret": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/6b0eee9c-6dc1-42fb-85cd-018753d72161/secret"
        },
        "grants": {
            "href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/applications/6b0eee9c-6dc1-42fb-85cd-018753d72161/grants"
        }
    },
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "id": "6b0eee9c-6dc1-42fb-85cd-018753d72161",
    "name": "SALES APPLICATION",
    "description": "Description for my sales application.",
    "enabled": true,
    "type": "NATIVE_APP",
    "loginPageUrl": "https://example.com",
    "protocol": "OPENID_CONNECT",
    "createdAt": "2022-07-28T20:25:32.263Z",
    "updatedAt": "2022-07-28T20:25:32.263Z",
    "assignActorRoles": false,
    "mobile": {
        "bundleId": "com.pingidentity.bundleId",
        "packageName": "com.pingidentity.packageName",
        "integrityDetection": {
            "mode": "DISABLED"
        },
        "passcodeRefreshDuration": {
            "duration": 30,
            "timeUnit": "SECONDS"
        }
    },
    "bundleId": "com.pingidentity.bundleId",
    "packageName": "com.pingidentity.packageName",
    "responseTypes": [
        "ID_TOKEN",
        "TOKEN"
    ],
    "grantTypes": [
        "IMPLICIT"
    ],
    "tokenEndpointAuthMethod": "CLIENT_SECRET_BASIC",
    "pkceEnforcement": "OPTIONAL",
    "postLogoutRedirectUris": [
        "https://example.com"
    ],
    "redirectUris": [
        "https://example.com:3000/code/response",
        "https://example.com",
        "https://example.com:3000/response"
    ]
}