Step 6: Submit registration data

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

The response from Step 5 shows the form data needed to submit the new user information for the registration request. The POST /{{envID}}/davinci/connections/{{connectionID}}/capabilities/{{capabilityName}} operation continues the flow to submit the new user data.

In this request:

id represents the ID returned by the previous Step in the flow.
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 REGISTER.
parameters.data.formData lists the properties to specify the email, password, givenName, and familyName for the new user.

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": "REGISTER",
      "formData": {
        "email" : "{{email}}",
        "password" : "{{userPassword}}",
        "givenName": "Otis",
        "familyName": "Driftwood"
      }
    }
  }
}

Example Request

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": {
        "email" : "{{email}}",
        "password" : "{{userPassword}}",
        "givenName": "Otis",
        "familyName": "Driftwood"
      }
    }
  }
}'

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" +
@"        ""email"" : ""{{email}}""," + "\n" +
@"        ""password"" : ""{{userPassword}}""," + "\n" +
@"        ""givenName"": ""Otis""," + "\n" +
@"        ""familyName"": ""Driftwood""    " + "\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": "REGISTER",
      "formData": {
        "email" : "{{email}}",
        "password" : "{{userPassword}}",
        "givenName": "Otis",
        "familyName": "Driftwood"
      }
    }
  }
}`)

  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": {
        "email" : "{{email}}",
        "password" : "{{userPassword}}",
        "givenName": "Otis",
        "familyName": "Driftwood"
      }
    }
  }
}

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        \"email\" : \"{{email}}\",\n        \"password\" : \"{{userPassword}}\",\n        \"givenName\": \"Otis\",\n        \"familyName\": \"Driftwood\"    \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": "REGISTER",
        "formData": {
          "email": "{{email}}",
          "password": "{{userPassword}}",
          "givenName": "Otis",
          "familyName": "Driftwood"
        }
      }
    }
  }),
};

$.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": {
          "email": "{{email}}",
          "password": "{{userPassword}}",
          "givenName": "Otis",
          "familyName": "Driftwood"
        }
      }
    }
  })

};
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": {
        "email": "{{email}}",
        "password": "{{userPassword}}",
        "givenName": "Otis",
        "familyName": "Driftwood"
      }
    }
  }
})
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        "email" : "{{email}}",\n        "password" : "{{userPassword}}",\n        "givenName": "Otis",\n        "familyName": "Driftwood"    \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": {
        "email": "{{email}}",
        "password": "{{userPassword}}",
        "givenName": "Otis",
        "familyName": "Driftwood"
      }
    }
  }
})

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        \"email\" : \"{{email}}\",\n        \"password\" : \"{{userPassword}}\",\n        \"givenName\": \"Otis\",\n        \"familyName\": \"Driftwood\"    \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": "03abb7ca-86fb-44bf-9c91-3d8d5324c4d2",
    "companyId": "abcddba86-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": "038bd1b248d412b3c....",
    "skProxyApiEnvironmentId": "us-west-2"
}

PingOne Platform APIs

Step 6: Submit registration data

Headers

Body

Example Request

Example Response