Skip to main content
PUT
/
api
/
v1
/
cyber-assurance
/
security-frameworks
/
{id}
cURL
curl --request PUT \
  --url https://app.aegister.com/api/v1/cyber-assurance/security-frameworks/{id} \
  --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"
    }
  ]
}'
{
  "error": 0,
  "messages": [],
  "data": {
    "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"
      }
    ]
  }
}

Authorizations

​
X-Aegister-Token
string
header
required

Path Parameters

​
id
integer
required

Body

​
title
string

Security framework title.

Examples:

"Sample Framework"

​
security_frameworks
any[]

JSON representation of Security Frameworks.

Examples:
[
  {
    "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

​
error
integer

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

Required range: 0 <= x <= 0
Examples:

0

​
messages
any[]

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

Examples:
[]
​
data
object