Risks

Get List of Risk Categories

Use this API to retrieve a list of all risk categories. The response will include details for each risk category along with the corresponding category ID, name, and description.

🗒 Things to Know

  • This API will return all active risk categories.
  • Each category will include its ID, name, and description.
get/api/risk/v2/risk-categories

Request

  • Base URL
    https://hostname
  • URL
    https://hostname/api/risk/v2/risk-categories
  • Auth
    OAuth 2
    Client credentials
    Token URL: https://{hostname}/api/access/v1/oauth/token scopes: INTEGRATION, RISK, RISK_READ

Response

OK

idstring uuid

Unique identifier of the category

namestring

Name of the category

nameKeystring

Localization key for the category name

seededboolean

Indicates if this is a seeded (pre-defined) category

archivedboolean

Indicates if the category is archived

descriptionstring

Detailed description of the category

descriptionKeystring

Localization key for the category description

Example response

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "name": "Security",
    "nameKey": "RiskCategory.Security",
    "seeded": true,
    "description": "Security related risks and controls",
    "descriptionKey": "RiskCategory.Security.Description"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.