Get Security Framework

Retrieve a Cyber Assurance Security Framework

Authorizations

X-Aegister-Token

string

header

required

Path Parameters

id

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

Example:

0

messages

any[]

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

Example:

[]

data

object

Show child attributes

data.id

number

Security Framework unique identifier.

Example:

3

data.title

string

Security Framework title.

Example:

"Lorem Ipsum dolor sit amet"

data.security_frameworks

object[]

Contains all security frameworks

Show child attributes

data.security_frameworks.id

string

Identifier for the security framework

Example:

"C1"

data.security_frameworks.type

enum<string>

Specify the type of the security framework

Available options:

control

data.security_frameworks.title

string

Security framework title

Example:

"Control 1"

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

Example:

0.2

data.security_frameworks.details

object

Other extra specification about the security framework.

Example:

{}

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[]

Attached files for an evidence.

data.security_frameworks.evidences.details

string

More information about the control execution.

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."

data.security_frameworks.evidences.datetime

string

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

Example:

0.2

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

Unique identifier for the user who executed the control.

data.security_frameworks.evidences.submitted_by.user_email

string

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.

Example:

"0 0 1 * *"

data.security_frameworks.description

string

Detailed security framework description.

Example:

"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Integer et posuere erat. Phasellus iaculis metus mauris, quis accumsan felis fermentum at."

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