devguard

RisksId

Get the details of a single risk by id.

GET
/risks/{id}/

Authorization

Authorization
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://app.devguard.ch/api/risks/string/"
{
  "id": "string",
  "shortId": -9007199254740991,
  "slug": "string",
  "name": "string",
  "ownerId": "string",
  "description": "string",
  "createdAt": "string",
  "updatedAt": "string",
  "organizationId": "string",
  "threatClassId": "string",
  "vulnerabilityClassId": "string",
  "impactDescription": "string",
  "initialProbabilityRating": 10,
  "initialImpactRating": 10,
  "residualProbabilityRating": 10,
  "residualImpactRating": 10,
  "treatmentType": "UNKNOWN",
  "treatmentDescription": "string",
  "owner": {
    "id": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "organizationId": "string",
    "users": [
      "string"
    ]
  },
  "threatClass": {
    "id": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "organizationId": "string"
  },
  "vulnerabilityClass": {
    "id": "string",
    "slug": "string",
    "name": "string",
    "description": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "organizationId": "string"
  },
  "affectedParties": [
    {
      "businessRoleId": "string",
      "riskId": "string",
      "organizationId": "string",
      "businessRole": {
        "id": "string",
        "slug": "string",
        "name": "string",
        "description": "string",
        "organizationId": "string",
        "users": [
          "string"
        ]
      }
    }
  ],
  "riskTreatments": [
    {
      "treatmentActionId": "string",
      "riskId": "string",
      "organizationId": "string",
      "treatmentAction": {
        "id": "string",
        "shortId": -9007199254740991,
        "slug": "string",
        "name": "string",
        "description": "string",
        "ownerId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "organizationId": "string",
        "dueDate": "string",
        "status": "UNKNOWN"
      }
    }
  ],
  "controlLinks": [
    {
      "id": "string",
      "controlCoverageId": "string",
      "riskId": "string",
      "organizationId": "string",
      "linkedAt": "string",
      "linkedBy": "string",
      "controlCoverage": {
        "id": "string",
        "frameworkAdoptionId": "string",
        "controlId": "string",
        "coverageStatus": "FULL",
        "coverageGap": "string",
        "lastReviewedAt": "string",
        "reviewedBy": "string",
        "policyId": "string",
        "sectionUid": "string",
        "organizationId": "string",
        "createdAt": "string",
        "updatedAt": "string",
        "control": {
          "id": "string",
          "frameworkId": "string",
          "parentId": "string",
          "identifier": "string",
          "slug": "string",
          "type": "CATEGORY",
          "isMandatory": true,
          "name": "string",
          "description": null,
          "purpose": "string",
          "isCentralized": true,
          "createdAt": "string",
          "updatedAt": "string"
        }
      }
    }
  ]
}
{
  "code": "BAD_REQUEST",
  "message": "Invalid input data",
  "issues": []
}
{
  "code": "UNAUTHORIZED",
  "message": "Authorization not provided",
  "issues": []
}
{
  "code": "FORBIDDEN",
  "message": "Insufficient access",
  "issues": []
}
{
  "code": "NOT_FOUND",
  "message": "Not found",
  "issues": []
}
{
  "code": "INTERNAL_SERVER_ERROR",
  "message": "Internal server error",
  "issues": []
}

How is this guide?