Step 1: Create a PingOne web application
POST {{apiPath}}/environments/{{envID}}/applications
This example shows the POST /environments/{{envID}}/applications operation to create a new application. This app configuration represents (to PingOne) the real application that users will query to sign-on.
In this request:
{{envID}}represents the environment ID for your environment.These properties are required in the request body:
enabled. The current enabled state of the application.name. The name of the application.type. The application type. In this workflow, thetypeisWEB_APP.protocol. The protocol used by the application. In this workflow, theprotocolisOPENID_CONNECT.grantTypes. The grant type for the authorization request. In this workflow, thegrantTypesproperty specifies theauthorization_codegrant type.responseTypes. The code or token type returned by an authorization request. In this workflow, theresponseTypesproperty specifiesCODE` to return an authorization code.tokenEndpointAuthMethod. The client authentication methods supported by the token endpoint. In this workflow, thetokenEndpointAuthMethodproperty specifiesCLIENT_SECRET_BASIC.
The response returns a
Status: 201 createdmessage and shows the new application's configuration data.The response data includes the application's
idproperty. Unless you're using the Qodex collection for this workflow (which sets the environment variables), you'll need to copy the applicationidproperty for use in a subsequent step.
See the following topics to learn more:
Request Body
{"enabled"=>true, "name"=>"DV-FlowApp_{{$timestamp}}", "description"=>"This is an OIDC Web application.", "type"=>"WEB_APP", "protocol"=>"OPENID_CONNECT", "grantTypes"=>["AUTHORIZATION_CODE"], "redirectUris"=>["https://www.example.com", "http://localhost:3000", "http://localhost:8080"], "responseTypes"=>["CODE"], "tokenEndpointAuthMethod"=>"CLIENT_SECRET_BASIC"}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Authorization | string | ||
Content-Type | string |