Skip to content
adversarial

Create a new proposal to change a threat profile

POST
/v1/threats/proposals
curl --request POST \
  --url https://api.adversarial.com/api/v1/threats/proposals \
  --header 'Content-Type: application/json' \
  --data '{ "positions": [ { "impact": "Very Low", "likelihood": "Remote", "name": "Sabotage" } ] }'

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
positions
required

Defines the new positions of the threats for this proposal action

Array<object>

A position of a threat.

This is used to calculate the consequence of moving a threat objective to a certain likelihood and impact.

object
impact
required

Y-axis for the threat objective

string
Allowed values: Very Low Low Medium High Severe
likelihood
required

X-axis for the threat objective

string
Allowed values: Remote Unlikely Possible Probable Imminent
name
required

PK of the threat objective in the database

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

Responses

Section titled “Responses”

201

Section titled “201”

Proposal created

Media typeapplication/json

A threat profile change proposal together with every action it contains.

object
actions
required
Array<object>

A single proposed threat change, with the inherent scores it would set.

object
action
required
object
comment
string | null
created_by
One of:
null
created_date
required
string format: date-time
deleted_date
string | null format: date-time
id
required
integer format: int64
updated_date
string | null format: date-time
scores
required
Array<object>

The current inherent scoring of a threat objective.

An inherent score is always scoped to one organization and one threat objective; it has no meaning outside that pairing.

object
created_date
required

The date the score was created.

string format: date-time
id
required

An auto-incrementing PK value that uniquely identifies the score given the threat objective name

integer format: int64
impact
required

The y-axis

string
Allowed values: Very Low Low Medium High Severe
is_draft
required

Whether this inherent score is a draft (excluded from some threat-level responses).

boolean
likelihood
required

The x-axis

string
Allowed values: Remote Unlikely Possible Probable Imminent
proposal_action_id
required

The proposal action PK that this score is associated with

integer format: int64
proposal_id
required

The proposal PK that this score is associated with

integer format: int64
threat_objective_name
required

The threat objective PK

string
Allowed values: Sabotage Data Disclosure Extortion Customer Targeting Resource Hijacking Fraud
proposal
required
object
approved_by
One of:
null
approved_date
string | null format: date-time
created_by
One of:
null
created_date
required
string format: date-time
denied_by
One of:
null
denied_date
string | null format: date-time
id
required
integer format: int64
Example
{
  "actions": [
    {
      "scores": [
        {
          "impact": "Very Low",
          "likelihood": "Remote",
          "threat_objective_name": "Sabotage"
        }
      ]
    }
  ]
}