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, the type is WEB_APP.
    • protocol. The protocol used by the application. In this workflow, the protocol is OPENID_CONNECT.
    • grantTypes. The grant type for the authorization request. In this workflow, the grantTypes property specifies the authorization_code grant 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, the tokenEndpointAuthMethod property specifies CLIENT_SECRET_BASIC.
  • The response returns a Status: 201 created message and shows the new application's configuration data.

  • The response data includes the application's id property. Unless you're using the Qodex collection for this workflow (which sets the environment variables), you'll need to copy the application id property 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

KeyDatatypeRequiredDescription
Authorizationstring
Content-Typestring