cURL
curl --request PUT \
--url https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid} \
--header 'Content-Type: application/json' \
--header 'X-Aegister-Token: <api-key>' \
--data '
{
"title": "Sample Framework",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
'import requests
url = "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}"
payload = {
"title": "Sample Framework",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
headers = {
"X-Aegister-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Sample Framework',
security_frameworks: [
{
id: 'C1',
type: 'control',
title: 'Control 1',
weight: 0.2,
details: {},
evidences: [],
frequency: '0 0 1 * *',
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
evidence_type: 'self'
}
]
})
};
fetch('https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}', 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://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}",
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([
'title' => 'Sample Framework',
'security_frameworks' => [
[
'id' => 'C1',
'type' => 'control',
'title' => 'Control 1',
'weight' => 0.2,
'details' => [
],
'evidences' => [
],
'frequency' => '0 0 1 * *',
'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
'evidence_type' => 'self'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Aegister-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://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}"
payload := strings.NewReader("{\n \"title\": \"Sample Framework\",\n \"security_frameworks\": [\n {\n \"id\": \"C1\",\n \"type\": \"control\",\n \"title\": \"Control 1\",\n \"weight\": 0.2,\n \"details\": {},\n \"evidences\": [],\n \"frequency\": \"0 0 1 * *\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"evidence_type\": \"self\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Aegister-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://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}")
.header("X-Aegister-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Sample Framework\",\n \"security_frameworks\": [\n {\n \"id\": \"C1\",\n \"type\": \"control\",\n \"title\": \"Control 1\",\n \"weight\": 0.2,\n \"details\": {},\n \"evidences\": [],\n \"frequency\": \"0 0 1 * *\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"evidence_type\": \"self\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Sample Framework\",\n \"security_frameworks\": [\n {\n \"id\": \"C1\",\n \"type\": \"control\",\n \"title\": \"Control 1\",\n \"weight\": 0.2,\n \"details\": {},\n \"evidences\": [],\n \"frequency\": \"0 0 1 * *\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"evidence_type\": \"self\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": 0,
"messages": [],
"security_framework": {
"id": 3,
"title": "Lorem Ipsum dolor sit amet",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [
{
"files": [
"/api/v1/documents/organizations/1/security-frameworks/1/documents/C1/xxxxxxxxxxx.jpg"
],
"details": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"datetime": "2023-11-07T05:31:56Z",
"completed": 0,
"residual_risk": 0.2,
"submitted_by": {
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "jsmith@example.com"
}
}
],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
}{
"error": 1,
"messages": [
"Invalid data provided"
]
}{
"error": 1,
"messages": [
9153
]
}{
"error": 1,
"messages": []
}Security Frameworks
Edit Organization associated Security Framework
Edit Cyber Assurance Association.
PUT
/
api
/
v1
/
organizations
/
{organizationid}
/
security-frameworks
/
{frameworkid}
cURL
curl --request PUT \
--url https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid} \
--header 'Content-Type: application/json' \
--header 'X-Aegister-Token: <api-key>' \
--data '
{
"title": "Sample Framework",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
'import requests
url = "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}"
payload = {
"title": "Sample Framework",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
headers = {
"X-Aegister-Token": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'X-Aegister-Token': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Sample Framework',
security_frameworks: [
{
id: 'C1',
type: 'control',
title: 'Control 1',
weight: 0.2,
details: {},
evidences: [],
frequency: '0 0 1 * *',
description: 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
evidence_type: 'self'
}
]
})
};
fetch('https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}', 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://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}",
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([
'title' => 'Sample Framework',
'security_frameworks' => [
[
'id' => 'C1',
'type' => 'control',
'title' => 'Control 1',
'weight' => 0.2,
'details' => [
],
'evidences' => [
],
'frequency' => '0 0 1 * *',
'description' => 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.',
'evidence_type' => 'self'
]
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Aegister-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://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}"
payload := strings.NewReader("{\n \"title\": \"Sample Framework\",\n \"security_frameworks\": [\n {\n \"id\": \"C1\",\n \"type\": \"control\",\n \"title\": \"Control 1\",\n \"weight\": 0.2,\n \"details\": {},\n \"evidences\": [],\n \"frequency\": \"0 0 1 * *\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"evidence_type\": \"self\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("X-Aegister-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://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}")
.header("X-Aegister-Token", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Sample Framework\",\n \"security_frameworks\": [\n {\n \"id\": \"C1\",\n \"type\": \"control\",\n \"title\": \"Control 1\",\n \"weight\": 0.2,\n \"details\": {},\n \"evidences\": [],\n \"frequency\": \"0 0 1 * *\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"evidence_type\": \"self\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["X-Aegister-Token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Sample Framework\",\n \"security_frameworks\": [\n {\n \"id\": \"C1\",\n \"type\": \"control\",\n \"title\": \"Control 1\",\n \"weight\": 0.2,\n \"details\": {},\n \"evidences\": [],\n \"frequency\": \"0 0 1 * *\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.\",\n \"evidence_type\": \"self\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"error": 0,
"messages": [],
"security_framework": {
"id": 3,
"title": "Lorem Ipsum dolor sit amet",
"security_frameworks": [
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [
{
"files": [
"/api/v1/documents/organizations/1/security-frameworks/1/documents/C1/xxxxxxxxxxx.jpg"
],
"details": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"datetime": "2023-11-07T05:31:56Z",
"completed": 0,
"residual_risk": 0.2,
"submitted_by": {
"user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"user_email": "jsmith@example.com"
}
}
],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]
}
}{
"error": 1,
"messages": [
"Invalid data provided"
]
}{
"error": 1,
"messages": [
9153
]
}{
"error": 1,
"messages": []
}Authorizations
ApiKeyAuthApiKeyQueryParam
Body
application/jsonmultipart/form-data
Security framework title.
Example:
"Sample Framework"
JSON representation of Security Frameworks.
Example:
[
{
"id": "C1",
"type": "control",
"title": "Control 1",
"weight": 0.2,
"details": {},
"evidences": [],
"frequency": "0 0 1 * *",
"description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at.",
"evidence_type": "self"
}
]