Playground

Playground

Risk

/api/v1/grc/risks

A GRC risk record, distinct from operational RiskItem.

listgetcreateupdate

Schema

FieldTypeNotes
id*uuidServer-assigned ULID with type prefix (e.g. per_…).
tenant_id*stringTenant scope — auto-stamped from the caller's JWT.
app_idstringApp scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present.
created_at*date-timeServer stamp.
updated_at*date-timeServer stamp; updated on every patch.
created_byuuidPerson id from the caller's JWT (sub).
updated_byuuidPerson id from the last writer's JWT (sub).
sourcestringProvenance tag — defaults to 'edm'.
source_typeenumfrontend | backend | server | system | apiWhere the write originated. Defaults to 'api'.
is_deletedbooleanSoft-delete flag. Excluded from default list queries.
deleted_atdate-timeStamped when soft-deleted; null otherwise.
deleted_byuuidPerson id who soft-deleted; null otherwise.
schema_versionnumberDocument schema version. Bumped on incompatible writes.
titlestringShort descriptive title for the risk.
descriptionstringDetailed description of the risk scenario and its potential impact.
categorystringDomain category of the risk.
owner_idstringID of the Person who owns this risk.
asset_idsjsonIDs of knowledge-graph asset entities threatened by this risk.
threat_actor_idsjsonIDs of knowledge-graph threat actor entities posing this risk.
inherent_likelihoodnumberInherent likelihood score (1–5) before controls are applied.
inherent_impactnumberInherent impact score (1–5) before controls are applied.
inherent_ratingnumberComputed inherent risk rating (inherentLikelihood × inherentImpact).
residual_likelihoodnumberResidual likelihood score (1–5) after controls are applied.
residual_impactnumberResidual impact score (1–5) after controls are applied.
residual_ratingnumberComputed residual risk rating (residualLikelihood × residualImpact).
mitigating_control_idsjsonIDs of Controls that mitigate this risk.
treatmentstringSelected risk treatment approach.
treatment_rationalestringExplanation of why this treatment was chosen.
statusstringCurrent lifecycle status of the risk.
acceptance_levelstringDelegation level for risk acceptance.
accepted_bystringID of the Person who formally accepted this risk.
accepted_atdate-timeISO 8601 timestamp when the risk was formally accepted.
next_review_datedate-timeDate when this risk is next due for reassessment.
last_assessed_atdate-timeISO 8601 timestamp of the most recent assessment.
assessment_notesstringNotes from the most recent assessment.
realized_incident_idsjsonIDs of Incidents that realized this risk.
tagsjsonFree-form tags for filtering.

API

client.grc.risks.*
Loading manifest…