Step 5: Start a registration subflow
POST {{authPath}}/{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}}
The response from the authorize request in Step 4 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:
-
idrepresents the ID returned by the authorize request. -
event_nameis the event name returned by the authorize request. For this call the event name iscontinue. -
parameters.eventTypespecifies thesubmitaction. -
parameters.data.actionKeyspecifies the action. In this workflow, the action isREGISTER. -
parameters.data.formDatafor the registration subflow is empty. The subflow will make another call in Step 6 to submit user registration data.
|
To return JSON instead of HTML in the response, this request includes an optional |
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": "REGISTER",
"formData": {
}
}
}
}'
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"": ""REGISTER""," + "\n" +
@" ""formData"": { " + "\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": "REGISTER",
"formData": {
}
}
}
}`)
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": "REGISTER",
"formData": {
}
}
}
}
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\": \"REGISTER\",\n \"formData\": { \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": "REGISTER",
"formData": {}
}
}
}),
};
$.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": "REGISTER",
"formData": {}
}
}
})
};
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": "REGISTER",
"formData": {}
}
}
})
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": "REGISTER",\n "formData": { \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": "REGISTER",
"formData": {}
}
}
})
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\": \"REGISTER\",\n \"formData\": { \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
{
"_links": {
"next": {
"href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/davinci/connections/867ed4363b2bc21c860085ad2baa817d/capabilities/customHTMLTemplate"
},
"self": {
"href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/davinci/connections/867ed4363b2bc21c860085ad2baa817d/capabilities/customHTMLTemplate"
}
},
"eventName": "continue",
"isResponseCompatibleWithMobileAndWebSdks": true,
"id": "1k5y98i1v1",
"interactionId": "035f7432-0a5a-415d-bdb9-e240f2c442e7",
"companyId": "abcdba86-d36e-413e-85b4-ee499a5cea55",
"flowId": "f49c54791bb78dc656d34e6ff38f6ffc",
"connectionId": "867ed4363b2bc21c860085ad2baa817d",
"capabilityName": "customHTMLTemplate",
"formData": {
"value": {
"email": "",
"password": "",
"givenName": "",
"familyName": ""
}
},
"form": {
"name": "Create Profile",
"description": "Enter name, email, and password to create a new account",
"category": "CUSTOM_HTML",
"components": {
"fields": [
{
"type": "TEXT",
"key": "email",
"label": "Email"
},
{
"type": "PASSWORD",
"key": "password",
"label": "Password"
},
{
"type": "TEXT",
"key": "givenName",
"label": "Given Name"
},
{
"type": "TEXT",
"key": "familyName",
"label": "Family Name"
},
{
"type": "SUBMIT_BUTTON",
"label": "Continue",
"key": "REGISTER"
},
{
"type": "FLOW_BUTTON",
"label": "Already have an account? Sign On",
"key": "CANCEL",
"inputType": "ACTION"
}
]
}
},
"interactionToken": "3123e15a0a24dc3e..."
}