Edit Organization associated Security Framework

Edit Cyber Assurance Association.

PUT /api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}

cURL

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": "<string>",
  "security_frameworks": "<array>"
}
'

import requests

url = "https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid}"

payload = {
    "title": "<string>",
    "security_frameworks": "<array>"
}
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: '<string>', security_frameworks: '<array>'})
};

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' => '<string>',
    'security_frameworks' => '<array>'
  ]),
  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\": \"<string>\",\n  \"security_frameworks\": \"<array>\"\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\": \"<string>\",\n  \"security_frameworks\": \"<array>\"\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\": \"<string>\",\n  \"security_frameworks\": \"<array>\"\n}"

response = http.request(request)
puts response.read_body

200

{
  "error": 0,
  "messages": "<array>",
  "security_framework": {
    "id": 123,
    "title": "<string>",
    "security_frameworks": [
      {
        "id": "<string>",
        "type": "control",
        "title": "<string>",
        "weight": 0.5,
        "details": {},
        "evidences": [
          {
            "files": [
              "<string>"
            ],
            "details": "<string>",
            "datetime": "2023-11-07T05:31:56Z",
            "residual_risk": 0.5,
            "submitted_by": {
              "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "user_email": "[e-mail]"
            }
          }
        ],
        "frequency": "<string>",
        "description": "<string>"
      }
    ]
  }
}

{
  "error": 0,
  "messages": "<array>"
}

{
  "error": 0,
  "messages": "<array>"
}

{
  "error": 0,
  "messages": "<array>"
}

Authorizations

ApiKeyAuthApiKeyQueryParam

X-Aegister-Token · string · header · required

Path Parameters

frameworkid · integer · required

organizationid · integer · required

Body

application/jsonmultipart/form-data

title · string

Security framework title.

Example:

"Sample Framework"

security_frameworks · array

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"
  }
]

Response

200

application/json

error · integer

Any value different from 0 indicates an error.
More details can be found in messages.

Required range: 0 <= x <= 0

Example:

0

messages · array

If error is 1, contains zero or more details on the error.

Example:

[]

security_framework · object

Show child attributes