Organisations
Choose the frameworks and the window of compliance evidence
Which frameworks the page shows and the days after which a diagram with no conclusive check on its default branch is stale.
PUT
/orgs/{org}/evidence/settingsTL;DR
| Question | Answer |
|---|---|
| What does it do? | Choose the frameworks and the window of compliance evidence. |
| What does it take? | A JSON body of type EvidenceSettingsBody. |
| What does it return? | Status 200 with a body of type EvidenceSettings. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 a member or a reader (orgs.forbidden), a plan without compliance evidence (plan.compliance_evidence_not_included), or an origin that may not make changes; 404 no such organisation, or the caller is not a member of it; 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Which frameworks the page shows and the days after which a diagram with no conclusive check on its default branch is stale. The owner and admins, on Enterprise. Audited.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
Request body
The body has the type EvidenceSettingsBody.
| Field | Type | Required | Description |
|---|---|---|---|
frameworks | ("pci-dss" | "soc2" | "iso27001" | "nist-800-53")[] | yes | The frameworks the page shows, each once. |
staleDays | integer | yes | Days without a conclusive check on the default branch after which a diagram is stale, 1 to 90. minimum 1; maximum 90. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | Saved. | EvidenceSettings |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member or a reader (orgs.forbidden), a plan without compliance evidence (plan.compliance_evidence_not_included), or an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation, or the caller is not a member of it. | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type EvidenceSettings.
| Field | Type | Required | Description |
|---|---|---|---|
frameworks | ("pci-dss" | "soc2" | "iso27001" | "nist-800-53")[] | yes | |
staleDays | integer | yes | |
defaults | boolean | yes | True when nothing was saved and these are the defaults: every framework, 14 days. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |