curl --request PUT \
--url https://pria.praxislxp.com/api/admin/account/{id} \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"name": "<string>",
"managerEmail": "jsmith@example.com",
"status": "active",
"credits": 123,
"aws_default_region": "<string>",
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"canvasClientSecret": "<string>",
"canvasFacultyAccessToken": "<string>"
}
'import requests
url = "https://pria.praxislxp.com/api/admin/account/{id}"
payload = {
"name": "<string>",
"managerEmail": "jsmith@example.com",
"status": "active",
"credits": 123,
"aws_default_region": "<string>",
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"canvasClientSecret": "<string>",
"canvasFacultyAccessToken": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
managerEmail: 'jsmith@example.com',
status: 'active',
credits: 123,
aws_default_region: '<string>',
aws_access_key_id: '<string>',
aws_secret_access_key: '<string>',
canvasClientSecret: '<string>',
canvasFacultyAccessToken: '<string>'
})
};
fetch('https://pria.praxislxp.com/api/admin/account/{id}', 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://pria.praxislxp.com/api/admin/account/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'managerEmail' => 'jsmith@example.com',
'status' => 'active',
'credits' => 123,
'aws_default_region' => '<string>',
'aws_access_key_id' => '<string>',
'aws_secret_access_key' => '<string>',
'canvasClientSecret' => '<string>',
'canvasFacultyAccessToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-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://pria.praxislxp.com/api/admin/account/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"managerEmail\": \"jsmith@example.com\",\n \"status\": \"active\",\n \"credits\": 123,\n \"aws_default_region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"canvasClientSecret\": \"<string>\",\n \"canvasFacultyAccessToken\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-access-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.put("https://pria.praxislxp.com/api/admin/account/{id}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"managerEmail\": \"jsmith@example.com\",\n \"status\": \"active\",\n \"credits\": 123,\n \"aws_default_region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"canvasClientSecret\": \"<string>\",\n \"canvasFacultyAccessToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/account/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"managerEmail\": \"jsmith@example.com\",\n \"status\": \"active\",\n \"credits\": 123,\n \"aws_default_region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"canvasClientSecret\": \"<string>\",\n \"canvasFacultyAccessToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "User institution deleted successfully"
}Update account
Updates an existing account. Disabling stops the account’s agent computers (they can be started again after the account is re-enabled).
curl --request PUT \
--url https://pria.praxislxp.com/api/admin/account/{id} \
--header 'Content-Type: application/json' \
--header 'x-access-token: <api-key>' \
--data '
{
"name": "<string>",
"managerEmail": "jsmith@example.com",
"status": "active",
"credits": 123,
"aws_default_region": "<string>",
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"canvasClientSecret": "<string>",
"canvasFacultyAccessToken": "<string>"
}
'import requests
url = "https://pria.praxislxp.com/api/admin/account/{id}"
payload = {
"name": "<string>",
"managerEmail": "jsmith@example.com",
"status": "active",
"credits": 123,
"aws_default_region": "<string>",
"aws_access_key_id": "<string>",
"aws_secret_access_key": "<string>",
"canvasClientSecret": "<string>",
"canvasFacultyAccessToken": "<string>"
}
headers = {
"x-access-token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
managerEmail: 'jsmith@example.com',
status: 'active',
credits: 123,
aws_default_region: '<string>',
aws_access_key_id: '<string>',
aws_secret_access_key: '<string>',
canvasClientSecret: '<string>',
canvasFacultyAccessToken: '<string>'
})
};
fetch('https://pria.praxislxp.com/api/admin/account/{id}', 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://pria.praxislxp.com/api/admin/account/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'managerEmail' => 'jsmith@example.com',
'status' => 'active',
'credits' => 123,
'aws_default_region' => '<string>',
'aws_access_key_id' => '<string>',
'aws_secret_access_key' => '<string>',
'canvasClientSecret' => '<string>',
'canvasFacultyAccessToken' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-access-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://pria.praxislxp.com/api/admin/account/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"managerEmail\": \"jsmith@example.com\",\n \"status\": \"active\",\n \"credits\": 123,\n \"aws_default_region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"canvasClientSecret\": \"<string>\",\n \"canvasFacultyAccessToken\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("x-access-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.put("https://pria.praxislxp.com/api/admin/account/{id}")
.header("x-access-token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"managerEmail\": \"jsmith@example.com\",\n \"status\": \"active\",\n \"credits\": 123,\n \"aws_default_region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"canvasClientSecret\": \"<string>\",\n \"canvasFacultyAccessToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://pria.praxislxp.com/api/admin/account/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"managerEmail\": \"jsmith@example.com\",\n \"status\": \"active\",\n \"credits\": 123,\n \"aws_default_region\": \"<string>\",\n \"aws_access_key_id\": \"<string>\",\n \"aws_secret_access_key\": \"<string>\",\n \"canvasClientSecret\": \"<string>\",\n \"canvasFacultyAccessToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "User institution deleted successfully"
}Authorizations
JWT token passed in x-access-token header
Path Parameters
Account ID
Body
Account name (lowercase, unique).
Email of the primary account manager (required).
active, inactive, deleted Initial credits
AWS region for the account's Amazon Bedrock / S3 / Transcribe calls (e.g. us-east-1). Used by every Digital Twin of the account that has no AWS keys of its own; a twin's own region wins.
IAM access key id. Signs the Bedrock, transcription, image and video calls of every Digital Twin of the account that has no AWS keys of its own; a twin's own pair always wins. Applied only together with the secret.
IAM secret access key paired with the access key id. Write-only: never returned by the API. On update, a blank value (or the masked placeholder) keeps the stored secret and null clears it. Clearing the access key id alone also disables the account pair.
Canvas developer key client secret. Write-only: never returned by the API (reads carry hasCanvasClientSecret). On update, a blank value (or the masked placeholder) keeps the stored secret and null clears it.
Canvas faculty access token. Write-only: never returned by the API (reads carry hasCanvasFacultyAccessToken). On update, a blank value (or the masked placeholder) keeps the stored secret and null clears it.
Was this page helpful?