Get client compliance
Requires detection.read. Results are scoped to the authenticated tenant. This reference is generated from source; consult the authenticated live schema for deployment-specific availability.
Authorizations
An Alignr API key.
Path Parameters
Response
Successful Response
GET /organizations/{orgId}/compliance (ComplianceGrid in
frontend/src/types/standards.ts).
The outcome of one control evaluated against one organisation — spec §5,
decided by ADR-0014 §4. Three of the five members are not "fail", even though
none of them is "pass" either: a control that has not affirmatively fired has
proved nothing, so no_data (population exists, no facts arrived),
not_covered (nothing connected here could ever supply the facts) and
not_applicable (disabled, or overridden out, for this organisation) stay
distinct outcomes rather than being folded into whichever of pass/fail is
cheaper to compute. Collapsing any of them into pass reproduces the exact
failure this design exists to rule out — a compliance grid rendering green for
a client nobody is actually monitoring.
PASS is spelled upper-case like every other member in this module — that
convention, not the keyword collision, is why it is not written pass. Its
value is still the reserved word "pass", which is fine: only the bare name
pass is a Python keyword, and nothing here ever writes one.
pass, fail, no_data, not_covered, not_applicable