Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Risk Templates

Get Risk Template

Use this API to retrieve the details for the specified risk template.

🗒 Things to Know

  • The templateId can be obtained from the OneTrust application URL when accessing the Template Details screen for a risk template.
get/api/risk-template/v1/templates/{riskTemplateId}

Path parameters

riskTemplateIdstring uuid required

The unique identifier used to retrieve a specific risk template.

Response

OK

idstring uuid

The unique identifier of the risk template.

namestring

The display name of the risk template.

riskNamestring

The name of the risk associated with this template.

descriptionstring

The detailed description of the risk template.

state'ACTIVE' | 'ARCHIVED'

The current status indicating if the template is active or archived.

treatmentPlanstring

The treatment plan text describing risk mitigation strategies.

createdDatestring date-time

The timestamp when the risk template was created.

attributeValuesobject

The custom attributes and their values specific to this risk template.

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Operational Risk Template",
    "riskName": "Operational Risk",
    "description": "A structured template to identify, assess, and manage risks",
    "state": "ACTIVE",
    "orgGroup": {
      "id": "7009201b-3808-4eaa-8afa-97f50c6c3cf1",
      "name": "Entity name"
    },
    "treatmentPlan": "Operational Risk treatment plan",
    "inherentRiskLevel": {
      "levelId": 1,
      "level": "Low",
      "impactLevelId": 1,
      "impactLevel": "Low",
      "probabilityLevelId": 1,
      "probabilityLevel": "Low",
      "riskScore": 2
    },
    "targetRiskLevel": {
      "levelId": 1,
      "level": "Low",
      "impactLevelId": 1,
      "impactLevel": "Low",
      "probabilityLevelId": 1,
      "probabilityLevel": "Low",
      "riskScore": 2
    },
    "threat": {
      "id": "f3e9e8b4-1c5e-4f3e-9c58-92d8d6d2ea7a",
      "name": "Threat Name",
      "identifier": "456"
    },
    "vulnerabilities": [
      {
        "id": "6e4b2d9a-7fc7-4ef2-8129-3a4f84e7d314",
        "name": "Threat Name",
        "identifier": "245"
      }
    ],
    "categories": [
      {
        "id": "d7e5c1a2-42a0-4cd7-83b1-d0a2ff064cb7",
        "name": "Category Name",
        "nameKey": "RiskCategory.Availability"
      }
    ],
    "controls": [
      {
        "id": "1a2b3c4e-5f6g-7h8i-9j0k-1l2m3n4o5p6q",
        "name": "Control Name",
        "identifier": "123"
      }
    ],
    "createdDate": "2025-07-15T09:27:53.123Z"
  }
]