Create MFA User Device (Voice)
POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/devices
The operation POST {{apiPath}}/environments/{{envID}}/users/{{userID}}/devices adds a new Voice MFA method to the specified user resource.
A valid phone number string must be provided in international format (includes a leading + character), for example, +14155552671.
Always include the country code in the value you provide for the phone parameter. Phone formats across the globe are constantly expanding and changing. If the country code is not included, issues might occur with message delivery.
The following sample shows acceptable valid phone attribute formatting for the same number:
+1.5125551234
+15125551234
+1.512.555.1234
15125551234
1-512-555-1234
+1 (512) 555-1234
Note that this example uses the optional parameter extension to create a device for a phone that has an extension in addition to the phone number.
Prerequisites
-
Refer to MFA Devices for important overview information.
Request Model
| Property | Type | Required? |
|---|---|---|
|
String |
Required |
|
String |
Required |
|
String |
Required |
|
String |
Optional |
|
Boolean |
Optional |
|
String |
Optional |
|
Date |
Optional |
|
String |
Optional |
|
Date |
Optional |
|
String |
Optional |
|
String |
Optional |
|
String |
Optional |
Refer to the Device properties data model for full property descriptions.
Example Request
-
cURL
-
C#
-
Go
-
HTTP
-
Java
-
jQuery
-
NodeJS
-
Python
-
PHP
-
Ruby
-
Swift
curl --location --globoff '{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer {{accessToken}}' \
--data '{
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
}'
var options = new RestClientOptions("{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")
{
MaxTimeout = -1,
};
var client = new RestClient(options);
var request = new RestRequest("", Method.Post);
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer {{accessToken}}");
var body = @"{" + "\n" +
@" ""type"": ""VOICE""," + "\n" +
@" ""phone"": ""+1.5125551111""," + "\n" +
@" ""extension"": ""313#""," + "\n" +
@" ""policy"": {" + "\n" +
@" ""id"": ""{{deviceAuthenticationPolicyID}}""" + "\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 := "{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices"
method := "POST"
payload := strings.NewReader(`{
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
}`)
client := &http.Client {
}
req, err := http.NewRequest(method, url, payload)
if err != nil {
fmt.Println(err)
return
}
req.Header.Add("Content-Type", "application/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}}/devices HTTP/1.1
Host: {{apiPath}}
Content-Type: application/json
Authorization: Bearer {{accessToken}}
{
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
}
OkHttpClient client = new OkHttpClient().newBuilder()
.build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\n \"type\": \"VOICE\",\n \"phone\": \"+1.5125551111\",\n \"extension\": \"313#\",\n \"policy\": {\n \"id\": \"{{deviceAuthenticationPolicyID}}\"\n }\n}");
Request request = new Request.Builder()
.url("{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")
.method("POST", body)
.addHeader("Content-Type", "application/json")
.addHeader("Authorization", "Bearer {{accessToken}}")
.build();
Response response = client.newCall(request).execute();
var settings = {
"url": "{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices",
"method": "POST",
"timeout": 0,
"headers": {
"Content-Type": "application/json",
"Authorization": "Bearer {{accessToken}}"
},
"data": JSON.stringify({
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
}),
};
$.ajax(settings).done(function (response) {
console.log(response);
});
var request = require('request');
var options = {
'method': 'POST',
'url': '{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices',
'headers': {
'Content-Type': 'application/json',
'Authorization': 'Bearer {{accessToken}}'
},
body: JSON.stringify({
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
})
};
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}}/devices"
payload = json.dumps({
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
})
headers = {
'Content-Type': 'application/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}}/devices');
$request->setMethod(HTTP_Request2::METHOD_POST);
$request->setConfig(array(
'follow_redirects' => TRUE
));
$request->setHeader(array(
'Content-Type' => 'application/json',
'Authorization' => 'Bearer {{accessToken}}'
));
$request->setBody('{\n "type": "VOICE",\n "phone": "+1.5125551111",\n "extension": "313#",\n "policy": {\n "id": "{{deviceAuthenticationPolicyID}}"\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("{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")
http = Net::HTTP.new(url.host, url.port);
request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer {{accessToken}}"
request.body = JSON.dump({
"type": "VOICE",
"phone": "+1.5125551111",
"extension": "313\#",
"policy": {
"id": "{{deviceAuthenticationPolicyID}}"
}
})
response = http.request(request)
puts response.read_body
let parameters = "{\n \"type\": \"VOICE\",\n \"phone\": \"+1.5125551111\",\n \"extension\": \"313#\",\n \"policy\": {\n \"id\": \"{{deviceAuthenticationPolicyID}}\"\n }\n}"
let postData = parameters.data(using: .utf8)
var request = URLRequest(url: URL(string: "{{apiPath}}/environments/{{envID}}/users/{{userID}}/devices")!,timeoutInterval: Double.infinity)
request.addValue("application/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.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26/devices/35798a33-0ed0-442b-902d-b273218dff7b"
},
"environment": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"href": "https://api.pingone.eu/v1/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/users/b30ac647-e33e-464f-a6ea-0275082d4c26"
}
},
"id": "35798a33-0ed0-442b-902d-b273218dff7b",
"environment": {
"id": "abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"
},
"user": {
"id": "b30ac647-e33e-464f-a6ea-0275082d4c26"
},
"type": "VOICE",
"status": "ACTIVE",
"createdAt": "2023-05-07T11:26:13.388Z",
"updatedAt": "2023-05-07T11:26:13.388Z",
"phone": "+1.5125551111",
"extension": "313#"
}