PingOne Platform APIs

Step 8: Start the sign-on flow

POST {{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}

The response from the authorize request in Step 7 provides the URL of the next API call in the flow in the next link. The POST /{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}} operation initiates the registration subflow.

In this request:

  • id represents the ID returned by the authorize request.

  • event_name is the event name returned by the authorize request. For this call the event name is continue.

  • parameters.eventType specifies the submit action.

  • parameters.data.actionKey specifies the action. In this workflow, the action is SIGNON.

  • parameters.data.formData specifies the username and password properties that you set in Steps 5 and 6.

To return JSON instead of HTML in the response, this request includes an optional X-Requested-With HTTP header with its value set to ping-sdk.

Headers

Content-Type      application/json

X-Requested-With      ping-sdk

interactionId      {{interactionID}}

interactionToken      {{interactionToken}}

Body

raw ( application/json )

{
  "id": "{{ID}}",
  "eventName": "continue",
  "parameters": {
    "eventType": "submit",
    "data": {
      "actionKey": "SIGNON",
      "formData": {
        "username" : "{{dvFlowUsername}}",
        "password" : "{{userPassword}}"
      }
    }
  }
}

Example Request

  • cURL

  • C#

  • Go

  • HTTP

  • Java

  • jQuery

  • NodeJS

  • Python

  • PHP

  • Ruby

  • Swift

curl --location --globoff '{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}' \
--header 'X-Requested-With: ping-sdk' \
--header 'interactionId: {{interactionID}}' \
--header 'interactionToken: {{interactionToken}}' \
--header 'Content-Type: application/json' \
--data '{
  "id": "{{ID}}",
  "eventName": "continue",
  "parameters": {
    "eventType": "submit",
    "data": {
      "actionKey": "SIGNON",
      "formData": {
        "username" : "{{dvFlowUsername}}",
        "password" : "{{userPassword}}"
      }
    }
  }
}'
var options = new RestClientOptions("{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}")
{
  MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("X-Requested-With", "ping-sdk");
request.AddHeader("interactionId", "{{interactionID}}");
request.AddHeader("interactionToken", "{{interactionToken}}");
request.AddHeader("Content-Type", "application/json");
var body = @"" + "\n" +
@"{" + "\n" +
@"  ""id"": ""{{ID}}""," + "\n" +
@"  ""eventName"": ""continue""," + "\n" +
@"  ""parameters"": {" + "\n" +
@"    ""eventType"": ""submit""," + "\n" +
@"    ""data"": {" + "\n" +
@"      ""actionKey"": ""SIGNON""," + "\n" +
@"      ""formData"": {       " + "\n" +
@"        ""username"" : ""{{dvFlowUsername}}""," + "\n" +
@"        ""password"" : ""{{userPassword}}""" + "\n" +
@"      }" + "\n" +
@"    }" + "\n" +
@"  }" + "\n" +
@"}" + "\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 := "{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}"
  method := "POST"

  payload := strings.NewReader(`{
  "id": "{{ID}}",
  "eventName": "continue",
  "parameters": {
    "eventType": "submit",
    "data": {
      "actionKey": "SIGNON",
      "formData": {
        "username" : "{{dvFlowUsername}}",
        "password" : "{{userPassword}}"
      }
    }
  }
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("X-Requested-With", "ping-sdk")
  req.Header.Add("interactionId", "{{interactionID}}")
  req.Header.Add("interactionToken", "{{interactionToken}}")
  req.Header.Add("Content-Type", "application/json")

  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 /{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}} HTTP/1.1
Host: {{authPath}}
X-Requested-With: ping-sdk
interactionId: {{interactionID}}
interactionToken: {{interactionToken}}
Content-Type: application/json

{
  "id": "{{ID}}",
  "eventName": "continue",
  "parameters": {
    "eventType": "submit",
    "data": {
      "actionKey": "SIGNON",
      "formData": {
        "username" : "{{dvFlowUsername}}",
        "password" : "{{userPassword}}"
      }
    }
  }
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "\n{\n  \"id\": \"{{ID}}\",\n  \"eventName\": \"continue\",\n  \"parameters\": {\n    \"eventType\": \"submit\",\n    \"data\": {\n      \"actionKey\": \"SIGNON\",\n      \"formData\": {       \n        \"username\" : \"{{dvFlowUsername}}\",\n        \"password\" : \"{{userPassword}}\"\n      }\n    }\n  }\n}\n\n\n");
Request request = new Request.Builder()
  .url("{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}")
  .method("POST", body)
  .addHeader("X-Requested-With", "ping-sdk")
  .addHeader("interactionId", "{{interactionID}}")
  .addHeader("interactionToken", "{{interactionToken}}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
var settings = {
  "url": "{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "X-Requested-With": "ping-sdk",
    "interactionId": "{{interactionID}}",
    "interactionToken": "{{interactionToken}}",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "id": "{{ID}}",
    "eventName": "continue",
    "parameters": {
      "eventType": "submit",
      "data": {
        "actionKey": "SIGNON",
        "formData": {
          "username": "{{dvFlowUsername}}",
          "password": "{{userPassword}}"
        }
      }
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});
var request = require('request');
var options = {
  'method': 'POST',
  'url': '{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}',
  'headers': {
    'X-Requested-With': 'ping-sdk',
    'interactionId': '{{interactionID}}',
    'interactionToken': '{{interactionToken}}',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "id": "{{ID}}",
    "eventName": "continue",
    "parameters": {
      "eventType": "submit",
      "data": {
        "actionKey": "SIGNON",
        "formData": {
          "username": "{{dvFlowUsername}}",
          "password": "{{userPassword}}"
        }
      }
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});
import requests
import json

url = "{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}"

payload = json.dumps({
  "id": "{{ID}}",
  "eventName": "continue",
  "parameters": {
    "eventType": "submit",
    "data": {
      "actionKey": "SIGNON",
      "formData": {
        "username": "{{dvFlowUsername}}",
        "password": "{{userPassword}}"
      }
    }
  }
})
headers = {
  'X-Requested-With': 'ping-sdk',
  'interactionId': '{{interactionID}}',
  'interactionToken': '{{interactionToken}}',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
  'follow_redirects' => TRUE
));
$request->setHeader(array(
  'X-Requested-With' => 'ping-sdk',
  'interactionId' => '{{interactionID}}',
  'interactionToken' => '{{interactionToken}}',
  'Content-Type' => 'application/json'
));
$request->setBody('{\n  "id": "{{ID}}",\n  "eventName": "continue",\n  "parameters": {\n    "eventType": "submit",\n    "data": {\n      "actionKey": "SIGNON",\n      "formData": {       \n        "username" : "{{dvFlowUsername}}",\n        "password" : "{{userPassword}}"\n      }\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("{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}")

http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["X-Requested-With"] = "ping-sdk"
request["interactionId"] = "{{interactionID}}"
request["interactionToken"] = "{{interactionToken}}"
request["Content-Type"] = "application/json"
request.body = JSON.dump({
  "id": "{{ID}}",
  "eventName": "continue",
  "parameters": {
    "eventType": "submit",
    "data": {
      "actionKey": "SIGNON",
      "formData": {
        "username": "{{dvFlowUsername}}",
        "password": "{{userPassword}}"
      }
    }
  }
})

response = http.request(request)
puts response.read_body
let parameters = "{\n  \"id\": \"{{ID}}\",\n  \"eventName\": \"continue\",\n  \"parameters\": {\n    \"eventType\": \"submit\",\n    \"data\": {\n      \"actionKey\": \"SIGNON\",\n      \"formData\": {       \n        \"username\" : \"{{dvFlowUsername}}\",\n        \"password\" : \"{{userPassword}}\"\n      }\n    }\n  }\n}"
let postData = parameters.data(using: .utf8)

var request = URLRequest(url: URL(string: "{{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}")!,timeoutInterval: Double.infinity)
request.addValue("ping-sdk", forHTTPHeaderField: "X-Requested-With")
request.addValue("{{interactionID}}", forHTTPHeaderField: "interactionId")
request.addValue("{{interactionToken}}", forHTTPHeaderField: "interactionToken")
request.addValue("application/json", forHTTPHeaderField: "Content-Type")

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

200 OK

{
    "interactionId": "03862c1e-6946-4ba9-809c-cd04dc9ebdd4",
    "companyId": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6",
    "connectionId": "cf474221121ff65b6ada03d50fd03034",
    "connectorId": "pingOneAuthenticationConnector",
    "id": "fbx7x6gnus",
    "capabilityName": "returnSuccessResponseRedirect",
    "environment": {
        "id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
    },
    "session": {
        "id": "44abd3d2-3be3-4413-8872-9ae149d5c83f"
    },
    "status": "COMPLETED",
    "authorizeResponse": {
        "code": "03a84b1a-32fb-4a0a-ba53-7424956db1d3"
    },
    "isResponseCompatibleWithMobileAndWebSdks": true,
    "sessionToken": "1106399d-e80b-41e0-8bdd-47309896ee93",
    "sessionTokenMaxAge": 2592000,
    "success": true,
    "resetCookie": true,
    "interactionToken": "eaa0fd40a8f6b432...",
    "_links": {
        "self": {
            "href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/davinci/connections/867ed4363b2bc21c860085ad2baa817d/capabilities/customHTMLTemplate"
        }
    },
    "subFlowSettings": {
        "reactSkUrl": "https://assets.pingone.com/davinci/latest/davinci.js",
        "cssUrl": null,
        "cssLinks": [],
        "jsLinks": [],
        "loadingScreenSettings": "{}",
        "useInternetExplorerTag": false
    }
}