Skip to content
Connect an agent

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

QuestionAnswer
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

FieldTypeRequiredDescription
orgstringyesThe organisation's id or its slug.
idstringyes

Responses

StatusMeaningBody
200The link, revoked.EvidenceShare
401Not signed in.ErrorResponse
403A member or a reader (orgs.forbidden), or an origin that may not make changes.ErrorResponse
404No such organisation or link (evidence.share_not_found).ErrorResponse
429Too many requests.ErrorResponse
503Organisations are not set up on this server.ErrorResponse

Response body

A 200 answer has the type EvidenceShare.

FieldTypeRequiredDescription
idstringyes
framework"pci-dss" | "soc2" | "iso27001" | "nist-800-53" | "all"yes
fromstringyes
tostringyes
paper"a4" | "letter"yes
labelstring | nullyes
protection"none" | "password" | "emails"yes
emailsstring[]yes
createdBystring | nullyes
createdAtintegeryes
expiresAtintegeryes
revokedAtinteger | nullyes
viewsintegeryesminimum 0.
lastViewedAtinteger | nullyes
state"live" | "expired" | "revoked"yes

See also

DocWhy
API referenceEvery endpoint, and the error envelope
SchemasEvery request and response type
Tool referenceThe operations as callable tools