Step 8: Register a new user
POST {{authPath}}/{{envID}}/flows/{{flowID}}
To register a new user, the flow service calls the POST /{{envID}}/flows/{{flowID}} endpoint operation and uses the application/vnd.pingidentity.user.register+json custom media type in the Content-type HTTP request header to identify the action.
The register user action requires the username, email, and password user schema properties in the request body to set up the new user account.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{authPath}}/{{envID}}/flows/{{flowID}}' \
--header 'Content-Type: application/vnd.pingidentity.user.register+json' \
--data '{
"username": "registered-user_1_{{$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
}'
var options = new RestClientOptions("{{authPath}}/{{envID}}/flows/{{flowID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.user.register+json");
var body = @"{" + "\n" +
@" ""username"": ""registered-user_1_{{$timestamp}}""," + "\n" +
@" ""email"": ""{{email}}""," + "\n" +
@" ""password"": ""{{userPassword}}""" + "\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}}/flows/{{flowID}}"
method := "POST"
payload := strings.NewReader(`{
"username": "registered-user_1_{{$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/vnd.pingidentity.user.register+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}}/flows/{{flowID}} HTTP/1.1
Host: {{authPath}}
Content-Type: application/vnd.pingidentity.user.register+json
{
"username": "registered-user_1_{{$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.user.register+json");
RequestBody body = RequestBody.create(mediaType, "{\n \"username\": \"registered-user_1_{{$timestamp}}\",\n \"email\": \"{{email}}\",\n \"password\": \"{{userPassword}}\"\n}");
Request request = new Request.Builder()
.url("{{authPath}}/{{envID}}/flows/{{flowID}}")
.method("POST", body)
.addHeader("Content-Type", "application/vnd.pingidentity.user.register+json")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{authPath}}/{{envID}}/flows/{{flowID}}",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/vnd.pingidentity.user.register+json"
},
"data": JSON.stringify({
"username": "registered-user_1_{{$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{authPath}}/{{envID}}/flows/{{flowID}}',
'headers': {
'Content-Type': 'application/vnd.pingidentity.user.register+json'
},
body: JSON.stringify({
"username": "registered-user_1_{{$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{authPath}}/{{envID}}/flows/{{flowID}}"
payload = json.dumps({
"username": "registered-user_1_{{$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
})
headers = {
'Content-Type': 'application/vnd.pingidentity.user.register+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}}/flows/{{flowID}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/vnd.pingidentity.user.register+json'
));
$request->setBody('{\n "username": "registered-user_1_{{$timestamp}}",\n "email": "{{email}}",\n "password": "{{userPassword}}"\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}}/flows/{{flowID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.user.register+json"
request.body = JSON.dump({
"username": "registered-user_1_{{\$timestamp}}",
"email": "{{email}}",
"password": "{{userPassword}}"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"username\": \"registered-user_1_{{$timestamp}}\",\n \"email\": \"{{email}}\",\n \"password\": \"{{userPassword}}\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{authPath}}/{{envID}}/flows/{{flowID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.user.register+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": {
"user.verify": {
"href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/0321ad7a-f526-407d-a1d2-8484ad08eb67"
},
"user.sendVerificationCode": {
"href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/0321ad7a-f526-407d-a1d2-8484ad08eb67"
},
"self": {
"href": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/flows/0321ad7a-f526-407d-a1d2-8484ad08eb67"
}
},
"id": "0321ad7a-f526-407d-a1d2-8484ad08eb67",
"resumeUrl": "https://auth.pingone.com/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/as/resume?flowId=0321ad7a-f526-407d-a1d2-8484ad08eb67",
"status": "VERIFICATION_CODE_REQUIRED",
"createdAt": "2021-04-26T23:42:41.037Z",
"expiresAt": "2021-04-27T00:12:15.447Z",
"_embedded": {
"application": {
"name": "RegistrationUseCaseApp"
}
}
}