Delete Organization associated Security Framework

Soft delete a Cyber Assurance Association.

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

Try it

cURL

cURL

curl --request DELETE \
  --url https://app.aegister.com/api/v1/organizations/{organizationid}/security-frameworks/{frameworkid} \
  --header 'X-Aegister-Token: <api-key>'

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",
            "completed": 0,
            "residual_risk": 0.5,
            "submitted_by": {
              "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "user_email": "[e-mail]"
            }
          }
        ],
        "frequency": "<string>",
        "description": "<string>",
        "evidence_type": "self"
      }
    ]
  }
}

Authorizations

X-Aegister-Token · string · header · required

Path Parameters

frameworkid · integer · required

organizationid · integer · required

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

messages · array

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

security_framework · object

Show child attributes

security_framework. id · number

Security Framework unique identifier.

security_framework. title · string

Security Framework title.

security_framework. security_frameworks · object[]

Contains all security frameworks

Show child attributes

security_framework.security_frameworks. id · string

Identifier for the security framework

security_framework.security_frameworks. type · enum<string>

Specify the type of the security framework

Available options: control

security_framework.security_frameworks. title · string

Security framework title

security_framework.security_frameworks. weight · number

The weight of the security framework.
All security frameworks in this array must add up to 1.0.

Required range: 0 <= x <= 1Must be a multiple of 0.1

security_framework.security_frameworks. details · object

Other extra specification about the security framework.

security_framework.security_frameworks. evidences · object[]

This will contain the history of the security framework execution.
This array is limited to max 200 elements.

Show child attributes

security_framework.security_frameworks.evidences. files · string<uri>[]

Attached files for an evidence.

security_framework.security_frameworks.evidences. details · string

More information about the control execution.

security_framework.security_frameworks.evidences. datetime · string<date-time>

security_framework.security_frameworks.evidences. completed · enum<integer>

Reports if evidence execution run correctly.

Available options: 0, 1

security_framework.security_frameworks.evidences. residual_risk · number

Indicates if the answer shows some issues that need to be addressed.
If residual risk is 1.0 needs urgent acting, if is 0.0 is safe.

Required range: 0 <= x <= 1Must be a multiple of 0.1

security_framework.security_frameworks.evidences. submitted_by · object

This object is set when the security framework evidence_type has self value.

Show child attributes

security_framework.security_frameworks.evidences.submitted_by. user_id · string<uuid>

Unique identifier for the user who executed the control.

security_framework.security_frameworks.evidences.submitted_by. user_email · string<email>

Email for the user who executed the control.

security_framework.security_frameworks. frequency · string

The security framework execution frequency.
It is specified using UNIX cron format.

security_framework.security_frameworks. description · string

Detailed security framework description.

security_framework.security_frameworks. evidence_type · enum<string>

Describes wheater the security framework is run automatically according to the frequency, or needs the user to act on the security framework.

Available options: self, automated