Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Risks

Create Risk

Use this API to create a new risk in the Risk Register. The response will include details of the created risk.

🗒 Things to Know

  • This API will create a new risk with the specified details.
  • The risk will be created in the default state.
  • This is a standalone risk creation endpoint.
post/api/risk/v3/risks

Request body

descriptionstring

description

treatmentPlanstring

treatment plan

orgGroupIdstring uuid required

organization group id

riskApproversIdstring[]

list of approver ids

categoryIdsstring[]

risk categories' Ids

threatIdstring uuid

risk threat' Id

vulnerabilityIdsstring[]

risk vulnerability' Ids

attributeValuesobject

Custom Attributes

deadlinestring date-time

deadline, format - YYYY-MM-DDTHH:MM:SS.FFFZ

reminderDaysinteger

number of days before the deadline when the reminder will be sent

entityIdToControlIdsobject

Map of control and related entities

controlIdsstring[]

Set of Control Ids

controlIdToCreateParameterobject

Map of controlId to create parameter

namestring

name

ignoreControlAutoInheritanceConfigurationboolean
treatmentstring

AKA remediation in current workflow

riskManagerstring[]

list of manager ids

Example request

{
  "riskOwners": [
    {
      "id": "e549ec16-b42a-4612-a402-3fcce7cc5f78",
      "name": "Acme Corp, John Doe"
    }
  ],
  "relatedEntities": [
    {
      "id": "d974c78a-c2f0-480a-aa27-4d40c44bb890",
      "type": "PIA",
      "sourceType": {
        "id": "3f99b4ac-7c66-45b6-8ff4-63a67a3ec7be",
        "label": "Inventory",
        "translationKey": "OBJ.Objective",
        "riskType": true,
        "moduleName": "Objective"
      },
      "name": "Raw Materials and Sales Inventory"
    }
  ],
  "controlRequestDtos": [
    {
      "identifier": "A.1.1",
      "name": "Control ABC",
      "orgGroupId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "description": "Testing Control",
      "recommendation": "Recommended",
      "frameworkId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "frameworkName": "NIST",
      "frameworkNameKey": "framework.NIST",
      "status": "Active",
      "categoryId": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
      "categoryName": "Access Control",
      "categoryNameKey": "category.AccessControl",
      "implementationGuidance": "Testing Control"
    }
  ]
}

Response

Created

string uuid required