Create a new risk

POST

/v1/risks

• Production
• Staging
• Local

Request Body

One of:

null

null

object

The required properties of a request to POST /risks

object

assigned_to_id

string | null format: uuid

closed_date

string | null format: date-time

control_statement

string | null

description

string

""

discovered_date

string | null format: date-time

due_date

string | null format: date-time

expected_date

string | null format: date-time

impact

One of:

null

null

string

string

Allowed values: Very Low Low Medium High Severe

impact_analysis

string | null

initially_reported_urgency

One of:

null

null

string

string

Allowed values: Critical High Medium Low Info

likelihood

One of:

null

null

string

string

Allowed values: Remote Unlikely Possible Probable Imminent

likelihood_analysis

string | null

remediation_task

string | null

source

string | null

status

One of:

null

null

string

The status of a risk

string

Allowed values: New Urgency Proposed Remediation Closure Proposed Closed

threat_objectives

array | null

A relational struct that has a threat objective type and its relevancy to a risk.

object

created_date

The time that this relation was mutated

string | null format: date-time

relevance

One of:

null

null

string

The relevancy of the threat objective to the risk. Typically a value of 1, or 2. While the relevancy is null the the database, implementations of retrieving this from postgres should ignore null values.

string

Allowed values: Moderate Substantial

threat_objective

required

The threat objective type

string

Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud

title

string

""

type

One of:

null

null

string

string

Allowed values: Code Configuration Control Deficiency Policy Procedural Vulnerability Third-party

Responses

201

Risk created succesfully

This struct is used to represent both OrgRisks and KeyRisks. It is used to display risks in the Risk Register

object

assigned_to

One of:

null

null

object

AKRs: assigned_to_id on org_key_risk_history OrgRisks: assigned_to_id on risk_history

object

email

required

string

first_name

required

string

icon

string | null format: image/png

Example

https://picsum.photos/200

id

required

string format: uuid

last_name

required

string

closed_date

AKRs: closed_date on org_key_risk_history OrgRisks: closed_date on risk_history

string | null format: date-time

comments

required

Risk_comment

integer format: int64

control_statement

The control statement for the risk

string | null

created_date

required

AKRs: the created_date is derived from created_date on org_key_risk_history. OrgRisks: created_date on risk

string format: date-time

description

required

KeyRisk: key_risk_history OrgRisk: risk_history

string

discovered_date

required

AKRs: discovered_date on org_key_risk_history OrgRisks: discovered_date on risk_history

string format: date-time

due_date

AKRs: due_date on org_key_risk_history OrgRisks: due_date on risk_history

string | null format: date-time

expected_date

AKRs: expected_date on org_key_risk_history OrgRisks: expected_date on risk_history

string | null format: date-time

id

required

string

Example

RSK-00001

impact

One of:

null

null

string

KeyRisk: org_key_risk_history OrgRisk: risk_history

string

Allowed values: Very Low Low Medium High Severe

impact_analysis

The impact analysis for the risk (for AI scoring analysis)

string | null

incident_associations

required

Associations to incident based on the incident_risk_assoc table

Array<string>

Example

INC-00001

initially_reported_urgency

One of:

null

null

string

AKRs: none OrgRisks: tentative urgency on risk_history

string

Allowed values: Critical High Medium Low Info

likelihood

One of:

null

null

string

KeyRisk: org_key_risk_history OrgRisk: risk_history

string

Allowed values: Remote Unlikely Possible Probable Imminent

likelihood_analysis

The likelihood analysis for the risk (for AI scoring analysis)

string | null

opened_by

One of:

null

null

object

AKRs: none OrgRisks: opened_by_id on risk_history

object

email

required

string

first_name

required

string

icon

string | null format: image/png

Example

https://picsum.photos/200

id

required

string format: uuid

last_name

required

string

remediation_task

The task to remediate the risk

string | null

source

KeyRisk: AKR_SOURCE, OrgRisk: risk_history

string | null

status

required

KeyRisk: org_key_risk_history OrgRisk: risk_history

string

Allowed values: New Urgency Proposed Remediation Closure Proposed Closed

tags

required

The tags applied to the risk

Array<object>

object

content

required

string

creator_id

required

string format: uuid

id

required

string format: uuid

org_id

string | null format: uuid

threat_objectives

required

AKRs: key_risk_threat_objective OrgRisks: risk_threat_objective

Array<object>

A relational struct that has a threat objective type and its relevancy to a risk.

object

created_date

The time that this relation was mutated

string | null format: date-time

relevance

One of:

null

null

string

The relevancy of the threat objective to the risk. Typically a value of 1, or 2. While the relevancy is null the the database, implementations of retrieving this from postgres should ignore null values.

string

Allowed values: Moderate Substantial

threat_objective

required

The threat objective type

string

Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud

title

required

KeyRisk: key_risk_history OrgRisk: risk_history

string

type

required

KeyRisk: key_risk_history, OrgRisk: risk_history

string

Allowed values: Code Configuration Control Deficiency Policy Procedural Vulnerability Third-party

updated_date

required

AKRs: updated_date on org_key_risk_history OrgRisks: created_date on risk_history

string format: date-time