Send Email Verification (Code)
POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification
The POST {{apiPath}}/environment/{{envID}}/users/{{userID}}/emailVerification operation initiates email verification by sending a code to the user’s email. The verification code expires after 24 hours and only the last code sent is valid. The request body requires the notificationType attribute indicating whether the person sending the request is an admin or user. This operation uses the application/vnd.pingidentity.user.emailVerification.send+json custom content type in the request header.
Refer also to Send/Resend User Verification Code.
Prerequisites
-
Refer to User Operations for important overview information.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification' \
--header 'Content-Type: application/vnd.pingidentity.user.emailVerification.send+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"notificationType": "admin"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.user.emailVerification.send+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""notificationType"": ""admin""" + "\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 := "{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification"
method := "POST"
payload := strings.NewReader(`{
"notificationType": "admin"
}`)
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.emailVerification.send+json")
req.Header.Add("Authorization", "Bearer {{accessToken}}")
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 /environments/{{envID}}/users/{{userID}}/emailVerification HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.user.emailVerification.send+json
Authorization: Bearer {{accessToken}}
{
"notificationType": "admin"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.user.emailVerification.send+json");
RequestBody body = RequestBody.create(mediaType, "{\n \"notificationType\": \"admin\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification")
.method("POST", body)
.addHeader("Content-Type", "application/vnd.pingidentity.user.emailVerification.send+json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/vnd.pingidentity.user.emailVerification.send+json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"notificationType": "admin"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification',
'headers': {
'Content-Type': 'application/vnd.pingidentity.user.emailVerification.send+json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"notificationType": "admin"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification"
payload = json.dumps({
"notificationType": "admin"
})
headers = {
'Content-Type': 'application/vnd.pingidentity.user.emailVerification.send+json',
'Authorization': 'Bearer {{accessToken}}'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
<?php
require_once 'HTTP/Request2.php';
$request = new HTTP_Request2();
$request->setUrl('{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/vnd.pingidentity.user.emailVerification.send+json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "notificationType": "admin"\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("{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.user.emailVerification.send+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"notificationType": "admin"
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"notificationType\": \"admin\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}/emailVerification")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.user.emailVerification.send+json", forHTTPHeaderField: "Content-Type")
request.addValue("Bearer {{accessToken}}", forHTTPHeaderField: "Authorization")
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": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"population": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/populations/c368d0c4-1b61-4774-9cf8-4c73279e532a"
},
"devices": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/devices"
},
"roleAssignments": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/roleAssignments"
},
"password": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"
},
"password.reset": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"
},
"password.set": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"
},
"password.check": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"
},
"password.recover": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/password"
},
"linkedAccounts": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/linkedAccounts"
},
"account.sendVerificationCode": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d"
},
"memberOfGroups": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/3b999aa3-9ce1-44b3-a75a-b9895132920d/memberOfGroups"
}
},
"enabled": true,
"identityProvider": {
"type": "PING_ONE"
},
"population": {
"id": "c368d0c4-1b61-4774-9cf8-4c73279e532a"
},
"lifecycle": {
"status": "ACCOUNT_OK"
},
"createdAt": "2022-12-02T19:57:03.987Z",
"emailVerified": false,
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"verifyStatus": "NOT_INITIATED",
"mfaEnabled": false,
"id": "3b999aa3-9ce1-44b3-a75a-b9895132920d",
"account": {
"canAuthenticate": true,
"status": "OK"
},
"email": "do-not-reply@pingidentity.com",
"updatedAt": "2022-12-02T19:58:14.279Z",
"username": "User"
}