Controls
Mark a control as evaluated
Records a control evaluation outcome along with its supporting evidence.
Authorization
ApiKeyAuth x-api-key<token>
In: header
Path Parameters
organizationId*string
controlId*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/organizations/string/controls/string/evaluate" \ -H "Content-Type: application/json" \ -d '{ "evaluationStatus": "pass", "evidence": { "evidenceType": "document" } }'{ "control": { "id": "string", "organizationId": "string", "templateId": "string", "templateVersion": 0, "key": "string", "name": "string", "description": "string", "domain": "string", "ownerUserId": "string", "ownerEmail": "string", "status": "not_started", "evaluationStatus": "pass", "evaluationSource": "tests", "evaluationFrequency": "continuous", "lastEvaluatedAt": "string", "lastEvaluatedByUserId": "string", "nextEvaluationDueAt": "string", "notes": "string", "archivedAt": "string", "dateCreated": null, "dateUpdated": null, "latestTemplateVersion": 0, "updateAvailable": true, "templateRetired": true, "implementationGuidance": "string", "testProcedure": "string", "suggestedEvidenceTypes": [ "string" ], "suggestedOwnerRole": "string", "property1": null, "property2": null }, "evidence": { "id": "string", "organizationId": "string", "controlId": "string", "evidenceType": "document", "tags": [ "string" ], "evidenceId": "string", "externalUrl": "string", "asset": { "bucket": "string", "key": "string", "fileName": "string", "contentType": "string", "fileSize": 0 }, "title": "string", "collectedAt": "string", "validFrom": "string", "validUntil": "string", "addedByUserId": "string", "notes": "string", "fulfillsTaskId": "string", "evidenceReleaseId": "string", "evidenceDocumentVersion": 0, "dateCreated": null, "dateUpdated": null, "property1": null, "property2": null }}