scf_risk_read
Read an organization's risk register: list or fetch risks, view the 5x5 matrix, summary and profile, and trace controls to risks or risks to controls by selecting a method.
Instructions
Read the risk register: list risks, one risk, the 5x5 matrix, summary, profile, risks for a control, or controls for a risk. Pick with method.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| method | Yes | list: List the whole risk register (ordered by risk code): scores, treatment status and any acceptance (accepted_by, accepted_at, rationale, expiry, acceptance_state). Filter by status, level, category. get: Get one risk assessment: inherent and residual scores, treatment plan, owner, review date, and any acceptance (accepted_by, accepted_at, rationale, expires_on, acceptance_state). matrix: Get the 5×5 risk matrix data for the organization — risk distribution across likelihood × impact, ready for visualization. summary: Get the organization's aggregate risk summary: totals by severity, treatment status breakdown, and trend data. profile: Get the organization's risk profile (read — viewer role): the severity thresholds that band the 5×5 matrix into low, medium, high and critical. Auto-created with defaults if unset. for_control: List the risk codes a control addresses and this organization's assessments of them (read — viewer role). Control-to-risk traceability from the SCF catalog mapping. controls_for_risk: List the controls that address a risk code (read — viewer role). Works for catalog risks (R-XX-N via the SCF mapping) and custom risks (R-ORG-N via the org's control mappings). | |
| org_id | Yes | Organization UUID — obtain from scf_list_organizations | |
| scf_id | No | SCF control ID in DOMAIN-NN format, e.g. IAC-01 Used by: for_control. | |
| status | No | Filter by treatment status: identified, analysed, treating, treated, accepted or monitoring (sent as the platform's treatment_status) Used by: list. | |
| risk_id | No | Risk assessment ID — obtain from scf_list_risks Used by: get. | |
| category | No | Filter by catalog risk category code, e.g. 'AC' matches R-AC-N Used by: list. | |
| risk_code | No | Risk code — catalog R-XX-N or custom R-ORG-N Used by: controls_for_risk. | |
| risk_level | No | Filter by inherent risk level, banded by the org's risk profile Used by: list. | |
| acceptance_state | No | Accepted risks only, by their approval: 'approved' (in force), 'expired' (past acceptance_expires_on) or 'unapproved' (accepted with no approval recorded) Used by: list. |