Get Organization associated Security Framework list

Retrieve Cyber Assurance Associations list

GET /api/v1/organizations/{organizationid}/security-frameworks

cURL

cURL

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

200

{
  "error": 0,
  "messages": "<array>",
  "total": 1,
  "data": [
    {
      "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

organizationid · integer · required

Query Parameters

limit · number · default: 50

Max number of reponse items.

offset · number · default: 0

Offset response items.

order · string

Order results by item field

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.

total · number

Total number of items that meet the list filter.
This doesn't represent the number of items inside the data array.

Required range: x >= 0

data · object[]

Show child attributes

data. id · number

Security Framework unique identifier.

data. title · string

Security Framework title.

data. security_frameworks · object[]

Contains all security frameworks

Show child attributes

data.security_frameworks. id · string

Identifier for the security framework

data.security_frameworks. type · enum<string>

Specify the type of the security framework

Available options: control

data.security_frameworks. title · string

Security framework title

data.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

data.security_frameworks. details · object

Other extra specification about the security framework.

data.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

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

Attached files for an evidence.

data.security_frameworks.evidences. details · string

More information about the control execution.

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

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

Reports if evidence execution run correctly.

Available options: 0, 1

data.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

data.security_frameworks.evidences. submitted_by · object

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

Show child attributes

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

Unique identifier for the user who executed the control.

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

Email for the user who executed the control.

data.security_frameworks. frequency · string

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

data.security_frameworks. description · string

Detailed security framework description.

data.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