curl --request POST \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/users \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"preferredEmail": "<string>",
"homePhone": "<string>",
"mobilePhone": "<string>",
"currencyCode": "<string>",
"timeZoneSid": "<string>",
"latitude": 123,
"longitude": 123,
"username": "<string>",
"password": "<string>",
"enabled": true,
"lmsId": "<string>",
"sisId": "<string>",
"exernalId": "<string>"
}
'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/users"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"preferredEmail": "<string>",
"homePhone": "<string>",
"mobilePhone": "<string>",
"currencyCode": "<string>",
"timeZoneSid": "<string>",
"latitude": 123,
"longitude": 123,
"username": "<string>",
"password": "<string>",
"enabled": True,
"lmsId": "<string>",
"sisId": "<string>",
"exernalId": "<string>"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: '<string>',
preferredEmail: '<string>',
homePhone: '<string>',
mobilePhone: '<string>',
currencyCode: '<string>',
timeZoneSid: '<string>',
latitude: 123,
longitude: 123,
username: '<string>',
password: '<string>',
enabled: true,
lmsId: '<string>',
sisId: '<string>',
exernalId: '<string>'
})
};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.smarterproctoring.com/v1/installs/{installSid}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'preferredEmail' => '<string>',
'homePhone' => '<string>',
'mobilePhone' => '<string>',
'currencyCode' => '<string>',
'timeZoneSid' => '<string>',
'latitude' => 123,
'longitude' => 123,
'username' => '<string>',
'password' => '<string>',
'enabled' => true,
'lmsId' => '<string>',
'sisId' => '<string>',
'exernalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.smarterproctoring.com/v1/installs/{installSid}/users"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredEmail\": \"<string>\",\n \"homePhone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"timeZoneSid\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"enabled\": true,\n \"lmsId\": \"<string>\",\n \"sisId\": \"<string>\",\n \"exernalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.smarterproctoring.com/v1/installs/{installSid}/users")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredEmail\": \"<string>\",\n \"homePhone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"timeZoneSid\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"enabled\": true,\n \"lmsId\": \"<string>\",\n \"sisId\": \"<string>\",\n \"exernalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredEmail\": \"<string>\",\n \"homePhone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"timeZoneSid\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"enabled\": true,\n \"lmsId\": \"<string>\",\n \"sisId\": \"<string>\",\n \"exernalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"preferredEmail": "<string>",
"username": "<string>",
"smarterIdEnrollmentSid": "<string>",
"mobilePhone": "<string>",
"homePhone": "<string>",
"address": "<string>",
"lmsId": "<string>",
"apiId": "<string>",
"sisId": "<string>",
"externalId": "<string>",
"latitude": 123,
"longitude": 123,
"lastEnrollmentSync": "<string>",
"currencyCode": "<string>",
"timeZoneSid": "<string>",
"timezone": {},
"maxTravelDistance": 123,
"maxTravelDistanceUnits": "<string>",
"createdDate": "<string>",
"editDate": "<string>",
"freshdeskUserId": "<string>",
"role": "<string>",
"enabled": true,
"authentication": {},
"smarterId": {},
"course": {},
"exam": {},
"identity": {}
}Create User
Creates a new user for the specified install.
curl --request POST \
--url https://api.smarterproctoring.com/v1/installs/{installSid}/users \
--header 'Content-Type: application/json' \
--header 'token: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"preferredEmail": "<string>",
"homePhone": "<string>",
"mobilePhone": "<string>",
"currencyCode": "<string>",
"timeZoneSid": "<string>",
"latitude": 123,
"longitude": 123,
"username": "<string>",
"password": "<string>",
"enabled": true,
"lmsId": "<string>",
"sisId": "<string>",
"exernalId": "<string>"
}
'import requests
url = "https://api.smarterproctoring.com/v1/installs/{installSid}/users"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"preferredEmail": "<string>",
"homePhone": "<string>",
"mobilePhone": "<string>",
"currencyCode": "<string>",
"timeZoneSid": "<string>",
"latitude": 123,
"longitude": 123,
"username": "<string>",
"password": "<string>",
"enabled": True,
"lmsId": "<string>",
"sisId": "<string>",
"exernalId": "<string>"
}
headers = {
"token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {token: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: '<string>',
preferredEmail: '<string>',
homePhone: '<string>',
mobilePhone: '<string>',
currencyCode: '<string>',
timeZoneSid: '<string>',
latitude: 123,
longitude: 123,
username: '<string>',
password: '<string>',
enabled: true,
lmsId: '<string>',
sisId: '<string>',
exernalId: '<string>'
})
};
fetch('https://api.smarterproctoring.com/v1/installs/{installSid}/users', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.smarterproctoring.com/v1/installs/{installSid}/users",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => '<string>',
'preferredEmail' => '<string>',
'homePhone' => '<string>',
'mobilePhone' => '<string>',
'currencyCode' => '<string>',
'timeZoneSid' => '<string>',
'latitude' => 123,
'longitude' => 123,
'username' => '<string>',
'password' => '<string>',
'enabled' => true,
'lmsId' => '<string>',
'sisId' => '<string>',
'exernalId' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"token: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.smarterproctoring.com/v1/installs/{installSid}/users"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredEmail\": \"<string>\",\n \"homePhone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"timeZoneSid\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"enabled\": true,\n \"lmsId\": \"<string>\",\n \"sisId\": \"<string>\",\n \"exernalId\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("token", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.smarterproctoring.com/v1/installs/{installSid}/users")
.header("token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredEmail\": \"<string>\",\n \"homePhone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"timeZoneSid\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"enabled\": true,\n \"lmsId\": \"<string>\",\n \"sisId\": \"<string>\",\n \"exernalId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.smarterproctoring.com/v1/installs/{installSid}/users")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"<string>\",\n \"preferredEmail\": \"<string>\",\n \"homePhone\": \"<string>\",\n \"mobilePhone\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"timeZoneSid\": \"<string>\",\n \"latitude\": 123,\n \"longitude\": 123,\n \"username\": \"<string>\",\n \"password\": \"<string>\",\n \"enabled\": true,\n \"lmsId\": \"<string>\",\n \"sisId\": \"<string>\",\n \"exernalId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"sid": "<string>",
"firstName": "<string>",
"lastName": "<string>",
"email": "<string>",
"preferredEmail": "<string>",
"username": "<string>",
"smarterIdEnrollmentSid": "<string>",
"mobilePhone": "<string>",
"homePhone": "<string>",
"address": "<string>",
"lmsId": "<string>",
"apiId": "<string>",
"sisId": "<string>",
"externalId": "<string>",
"latitude": 123,
"longitude": 123,
"lastEnrollmentSync": "<string>",
"currencyCode": "<string>",
"timeZoneSid": "<string>",
"timezone": {},
"maxTravelDistance": 123,
"maxTravelDistanceUnits": "<string>",
"createdDate": "<string>",
"editDate": "<string>",
"freshdeskUserId": "<string>",
"role": "<string>",
"enabled": true,
"authentication": {},
"smarterId": {},
"course": {},
"exam": {},
"identity": {}
}Authorizations
Path Parameters
Install Sid
^AI[a-f0-9]{32}$Body
First Name
Last Name
Preferred Email
Home Phone
Mobile Phone
Currency code
Time Zone Sid
^TZ[a-f0-9]{32}$Location Latitude
Location Longitude
Username for user
Password for user
^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)(?=.*[#$@!%&*?])[A-Za-z\d#$@!%&*?]{8,30}$If login as this user is enabled
The id for the user as defined in the LMS as defined in the LTI launch.
The id for the user as defined in the SIS.
The id for the user as defined in any external system for tracking.
Response
Successful
User SID
First name
Last name
Preferred email
Username
SmarterID enrollment SID
Mobile phone
Home phone
Address
LMS ID
API ID
SIS ID
External ID
Latitude
Longitude
Last enrollment sync
Currency code
Time zone SID
Timezone details
Max travel distance
Max travel distance units
Created date
Edit date
Freshdesk user ID
Role
Enabled
Authentication data
SmarterID data
Course
Exam
Identity
Was this page helpful?
