Activate Trusted Email Address
POST {{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}
The POST {{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}} operation is used to activate a new trusted email address resource of the trusted email domain in the specified environment. This operation uses the application/vnd.pingidentity.trustedEmail.activate+json custom media type as the content type in the request header.
|
The email address can be activated in the 24-hour period after the verification code has been sent. |
Prerequisites
-
Create a trusted email domain to get an
emailDomainIDfor the endpoint. Refer also to Notifications, especially Trusted Email Domains. -
Create a trusted email address to get a
trustedEmailIDfor the endpoint. Refer also to Notifications, especially Trusted Email Addresses.
Request Model
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
Refer to the Trusted email domains data models for full property descriptions.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}' \
--header 'Content-Type: application/vnd.pingidentity.trustedEmail.activate+json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"verificationCode":"avu0w4lt"
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/vnd.pingidentity.trustedEmail.activate+json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{ " + "\n" +
@" ""verificationCode"":""avu0w4lt""" + "\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}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}"
method := "POST"
payload := strings.NewReader(`{
"verificationCode":"avu0w4lt"
}`)
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.trustedEmail.activate+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}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}} HTTP/1.1
Host: {{apiPath}}
Content-Type: application/vnd.pingidentity.trustedEmail.activate+json
Authorization: Bearer {{accessToken}}
{
"verificationCode":"avu0w4lt"
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/vnd.pingidentity.trustedEmail.activate+json");
RequestBody body = RequestBody.create(mediaType, "{ \n \"verificationCode\":\"avu0w4lt\"\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}")
.method("POST", body)
.addHeader("Content-Type", "application/vnd.pingidentity.trustedEmail.activate+json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/vnd.pingidentity.trustedEmail.activate+json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"verificationCode": "avu0w4lt"
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}',
'headers': {
'Content-Type': 'application/vnd.pingidentity.trustedEmail.activate+json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"verificationCode": "avu0w4lt"
})
};
request(options, function (error, response) {
if (error) throw new Error(error);
console.log(response.body);
});
import requests
import json
url = "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}"
payload = json.dumps({
"verificationCode": "avu0w4lt"
})
headers = {
'Content-Type': 'application/vnd.pingidentity.trustedEmail.activate+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}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/vnd.pingidentity.trustedEmail.activate+json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{ \n "verificationCode":"avu0w4lt"\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}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/vnd.pingidentity.trustedEmail.activate+json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"verificationCode": "avu0w4lt"
})
response = http.request(request)
puts response.read_body
let parameters = "{ \n \"verificationCode\":\"avu0w4lt\"\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/emailDomains/{{emailDomainID}}/trustedEmails/{{trustedEmailID}}")!,timeoutInterval: Double.infinity)
request.addValue("application/vnd.pingidentity.trustedEmail.activate+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
201 Created
{
"_links": {
"self": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/abe400ab-674d-42ac-9a70-7c911d7bcace/trustedEmails/17665a60-9fc5-40c2-90e3-91494bbe38be"
},
"environment": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"emailDomain": {
"href": "https://api.pingone.com/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/emailDomains/abe400ab-674d-42ac-9a70-7c911d7bcace"
}
},
"id": "17665a60-9fc5-40c2-90e3-91494bbe38be",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"domain": {
"id": "abe400ab-674d-42ac-9a70-7c911d7bcace"
},
"emailAddress": "noreply1@auth.shopco.com",
"status": "ACTIVE",
"createdAt": "2020-06-21T14:33:47.511Z",
"updatedAt": "2020-06-21T14:33:47.511Z",
"domainId": "abe400ab-674d-42ac-9a70-7c911d7bcace"
}