Organisations
Revoke an auditor share link
Ends a share link now; it stays in the list as revoked.
DELETE
/orgs/{org}/evidence/shares/{id}TL;DR
| Question | Answer |
|---|---|
| What does it do? | Revoke an auditor share link. |
| What does it take? | org, id in the path. |
| What does it return? | Status 200 with a body of type EvidenceShare. |
| What can go wrong? | 401 not signed in; 403 a member or a reader (orgs.forbidden), or an origin that may not make changes; 404 no such organisation or link (evidence.share_not_found); 429 too many requests; 503 organisations are not set up on this server. Every failure uses the one error envelope. |
What it does
Ends a share link now; it stays in the list as revoked. The owner and admins. Audited.
Path parameters
| Field | Type | Required | Description |
|---|---|---|---|
org | string | yes | The organisation's id or its slug. |
id | string | yes |
Responses
| Status | Meaning | Body |
|---|---|---|
| 200 | The link, revoked. | EvidenceShare |
| 401 | Not signed in. | ErrorResponse |
| 403 | A member or a reader (orgs.forbidden), or an origin that may not make changes. | ErrorResponse |
| 404 | No such organisation or link (evidence.share_not_found). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
| 503 | Organisations are not set up on this server. | ErrorResponse |
Response body
A 200 answer has the type EvidenceShare.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | |
framework | "pci-dss" | "soc2" | "iso27001" | "nist-800-53" | "all" | yes | |
from | string | yes | |
to | string | yes | |
paper | "a4" | "letter" | yes | |
label | string | null | yes | |
protection | "none" | "password" | "emails" | yes | |
emails | string[] | yes | |
createdBy | string | null | yes | |
createdAt | integer | yes | |
expiresAt | integer | yes | |
revokedAt | integer | null | yes | |
views | integer | yes | minimum 0. |
lastViewedAt | integer | null | yes | |
state | "live" | "expired" | "revoked" | yes |
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 |