{ "openapi": "3.1.0", "info": { "title": "Concord Trust API", "description": "The Concord Trust API provides access to the Trust and GRC surfaces: controls, risk, and the trust center, for registered organizations.", "version": "4.23.0", "contact": { "email": "support@concord.tech", "name": "Concord Technologies Inc.", "url": "https://www.concord.tech" }, "license": { "name": "Proprietary", "url": "https://www.concord.tech/legal/saas-agreement" }, "termsOfService": "https://www.concord.tech/legal/saas-agreement" }, "components": { "securitySchemes": { "ApiKeyAuth": { "name": "x-api-key", "type": "apiKey", "in": "header", "description": "" } }, "schemas": {} }, "paths": { "/organizations/{organizationId}/controls": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls", "summary": "List controls", "tags": [ "Controls" ], "description": "Lists the controls in the organization, filtered by the given query parameters.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} } }, "total": { "type": "number" }, "capped": { "type": "boolean" } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_controls", "summary": "Create a control", "tags": [ "Controls" ], "description": "Creates a custom control in the organization control library.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" }, "key": { "type": "string", "minLength": 1 }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "type": "string" }, "ownerEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "notes": { "type": "string" } }, "required": [ "key" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/due": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_due", "summary": "List controls due soon", "tags": [ "Controls" ], "description": "Lists controls whose next review is due within the given number of days.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} } }, "total": { "type": "number" }, "capped": { "type": "boolean" } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid", "summary": "Get a control", "tags": [ "Controls" ], "description": "Returns a single control by id.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_controls_controlid", "summary": "Delete a control", "tags": [ "Controls" ], "description": "Deletes a control from the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_controls_controlid", "summary": "Update a control", "tags": [ "Controls" ], "description": "Updates fields on an existing control, such as its status, owner, or evaluation frequency.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "anyOf": [ { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, { "type": "string", "enum": [ "" ] } ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "nextEvaluationDueAt": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "notes": { "type": "string" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/requirements": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_requirements", "summary": "List control requirements", "tags": [ "Controls" ], "description": "Lists the framework requirements mapped to a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string" }, "frameworkShortName": { "type": "string" }, "organizationFrameworkId": { "type": "string" } }, "required": [ "externalId" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/library": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_library", "summary": "List the control library", "tags": [ "Controls" ], "description": "Lists every active control template with its adoption status, independent of any framework.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "templateId": { "type": "string" }, "controlId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "library": { "type": "string" }, "recommended": { "type": "boolean" }, "adopted": { "type": "boolean" }, "removed": { "type": "boolean" }, "coveredByKey": { "type": "string" }, "scfMappings": { "type": "array", "items": { "type": "string" } } }, "required": [ "templateId", "key", "library", "recommended", "adopted", "scfMappings" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/add-from-templates": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_add_from_templates", "summary": "Add controls from templates", "tags": [ "Controls" ], "description": "Creates controls in the organization from the given library template ids.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "controlsCreated": { "type": "number" }, "controlsRestored": { "type": "number" } }, "required": [ "controlsCreated", "controlsRestored" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/{organizationFrameworkId}/control-library": { "get": { "operationId": "get_trust_v1_organizations_organizationid_frameworks_organizationframeworkid_control_library", "summary": "List a framework control library", "tags": [ "Controls" ], "description": "Lists the control templates available for a specific adopted framework.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "organizationFrameworkId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "templateId": { "type": "string" }, "controlId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "library": { "type": "string" }, "recommended": { "type": "boolean" }, "adopted": { "type": "boolean" }, "removed": { "type": "boolean" }, "coveredByKey": { "type": "string" }, "scfMappings": { "type": "array", "items": { "type": "string" } } }, "required": [ "templateId", "key", "library", "recommended", "adopted", "scfMappings" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/evidence": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_evidence", "summary": "List evidence for a control", "tags": [ "Controls" ], "description": "Lists the evidence items linked to a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_evidence", "summary": "Add control evidence", "tags": [ "Controls" ], "description": "Adds evidence to a control as a linked document, an external URL, or an uploaded file.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string", "maxLength": 64 } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "validFrom": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "validUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "collectedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "evidenceType", "collectedAt" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}/control-mappings": { "get": { "operationId": "get_trust_v1_organizations_organizationid_documents_documentid_control_mappings", "summary": "List control mappings for a document", "tags": [ "Controls" ], "description": "Lists the controls a document is linked to as evidence, along with the recommended keys from its template.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "controlId": { "type": "string" }, "controlEvidenceId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "frameworks": { "type": "array", "items": { "type": "string" } }, "evidenceDocumentVersion": { "type": "number" } }, "required": [ "controlId", "controlEvidenceId", "evidenceType", "key", "name", "status", "evaluationStatus", "frameworks" ], "additionalProperties": false } }, "total": { "type": "number" }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}/control-mappings/reset": { "post": { "operationId": "post_trust_v1_organizations_organizationid_documents_documentid_control_mappings_reset", "summary": "Reset control mappings to the template default", "tags": [ "Controls" ], "description": "Resets the control mappings for a document to the set recommended by its source template.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "controlId": { "type": "string" }, "controlEvidenceId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "key": { "type": "string" }, "name": { "type": "string" }, "domain": { "type": "string" }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "frameworks": { "type": "array", "items": { "type": "string" } }, "evidenceDocumentVersion": { "type": "number" } }, "required": [ "controlId", "controlEvidenceId", "evidenceType", "key", "name", "status", "evaluationStatus", "frameworks" ], "additionalProperties": false } }, "total": { "type": "number" }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}/control-mappings/refresh-evidence": { "post": { "operationId": "post_trust_v1_organizations_organizationid_documents_documentid_control_mappings_refresh_evidence", "summary": "Refresh evidence bindings for a document", "tags": [ "Controls" ], "description": "Repoints the evidence links for a document to its currently published release.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "number" } }, "required": [ "updated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/comments": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_comments", "summary": "List control comments", "tags": [ "Controls" ], "description": "Lists the discussion comments on a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "type": "string", "enum": [ "control" ] }, "referenceId": { "type": "string" }, "authorType": { "type": "string", "enum": [ "user", "auditor" ] }, "authorId": { "type": "string" }, "authorName": { "type": "string" }, "body": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "type", "referenceId", "authorType", "authorId", "body" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_comments", "summary": "Add a control comment", "tags": [ "Controls" ], "description": "Adds a comment to the discussion thread on a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "type": "string", "enum": [ "control" ] }, "referenceId": { "type": "string" }, "authorType": { "type": "string", "enum": [ "user", "auditor" ] }, "authorId": { "type": "string" }, "authorName": { "type": "string" }, "body": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "type", "referenceId", "authorType", "authorId", "body" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/auditor-reviews": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_auditor_reviews", "summary": "List auditor reviews for a control", "tags": [ "Controls" ], "description": "Lists the verdicts auditors have recorded for a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "reviewStatus": { "type": "string", "enum": [ "not_reviewed", "in_review", "accepted", "needs_more_info", "exception" ] }, "dateUpdated": {} }, "required": [ "reviewStatus" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/evidence/{controlEvidenceId}": { "delete": { "operationId": "delete_trust_v1_organizations_organizationid_evidence_controlevidenceid", "summary": "Delete an evidence item", "tags": [ "Controls" ], "description": "Deletes an evidence item and removes its uploaded file from storage if it has one.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlEvidenceId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/evidence/expiring": { "get": { "operationId": "get_trust_v1_organizations_organizationid_evidence_expiring", "summary": "List expiring evidence", "tags": [ "Controls" ], "description": "Lists evidence items expiring within the given number of days.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/evidence": { "get": { "operationId": "get_trust_v1_organizations_organizationid_evidence", "summary": "List all evidence", "tags": [ "Controls" ], "description": "Lists every evidence item across all controls in the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/evidence/upload": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_evidence_upload", "summary": "Upload an evidence file to a control", "tags": [ "Controls" ], "description": "Uploads a file and adds it as evidence on a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/evidence/{controlEvidenceId}/file": { "get": { "operationId": "get_trust_v1_organizations_organizationid_evidence_controlevidenceid_file", "summary": "Get an evidence file URL", "tags": [ "Controls" ], "description": "Returns a short-lived URL to view or download an uploaded evidence file.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlEvidenceId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks": { "get": { "operationId": "get_trust_v1_organizations_organizationid_frameworks", "summary": "List adopted frameworks", "tags": [ "Controls" ], "description": "Lists the frameworks the organization has adopted.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "frameworkId": { "type": "string" }, "status": { "type": "string", "enum": [ "planning", "active", "audit_in_progress", "attested", "archived" ] }, "controlMode": { "type": "string", "enum": [ "recommended", "advanced", "custom" ] }, "scopeDescription": { "type": "string" }, "inScopeCategories": { "type": "array", "items": { "type": "string" } }, "attestationStartedAt": { "type": "string" }, "attestationCompletedAt": { "type": "string" }, "attestationReportDocumentId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "auditPeriodStart": { "type": "string" }, "auditPeriodEnd": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "completed", "archived" ] } }, "required": [ "id", "firmName", "status" ], "additionalProperties": {} }, "dateCreated": {}, "dateUpdated": {}, "frameworkKey": { "type": "string" }, "frameworkShortName": { "type": "string" }, "frameworkName": { "type": "string" }, "frameworkVersion": { "type": "string" }, "frameworkAuthority": { "type": "string" }, "frameworkCategory": { "type": "string" }, "frameworkDescription": { "type": "string" }, "frameworkLicense": { "type": "string" } }, "required": [ "id", "organizationId", "frameworkId", "status" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/{organizationFrameworkId}/coverage": { "get": { "operationId": "get_trust_v1_organizations_organizationid_frameworks_organizationframeworkid_coverage", "summary": "Get framework coverage", "tags": [ "Controls" ], "description": "Returns the control coverage for an adopted framework.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "organizationFrameworkId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "requirement": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": "string" }, "level": { "type": "string" }, "shortName": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "externalId", "level" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "covered", "partial", "not_covered", "not_applicable" ] }, "coveringControlIds": { "type": "array", "items": { "type": "string" } }, "mappedControls": { "type": "array", "items": { "type": "object", "properties": { "templateId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "recommended": { "type": "boolean" }, "adopted": { "type": "boolean" }, "controlId": { "type": "string" } }, "required": [ "templateId", "key", "name", "recommended", "adopted" ], "additionalProperties": false } }, "notApplicableJustification": { "type": "string" }, "operatingStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] } }, "required": [ "requirement", "status", "coveringControlIds" ], "additionalProperties": false } }, "summary": { "type": "object", "properties": { "covered": { "type": "number" }, "partial": { "type": "number" }, "not_covered": { "type": "number" }, "not_applicable": { "type": "number" } }, "required": [ "covered", "partial", "not_covered", "not_applicable" ], "additionalProperties": false } }, "required": [ "items", "summary" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/adoptable": { "get": { "operationId": "get_trust_v1_organizations_organizationid_frameworks_adoptable", "summary": "List adoptable frameworks", "tags": [ "Controls" ], "description": "Lists frameworks available in the catalog that the organization can adopt.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "shortName": { "type": "string" }, "version": { "type": "string" }, "authority": { "type": "string" }, "category": { "type": "string" }, "customerFacing": { "type": "boolean" }, "status": { "type": "string" }, "description": { "type": "string" }, "effectiveDate": { "type": "string" }, "retiredDate": { "type": "string" }, "license": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "requirementCount": { "type": "number" }, "recommendedControlCount": { "type": "number" }, "mappedControlCount": { "type": "number" }, "requirementCountByCategory": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "recommendedControlCountByScope": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "number" } }, "mappedControlCategories": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } } }, "required": [ "id", "key", "name", "shortName", "version", "authority", "category", "customerFacing", "status", "description", "requirementCount", "recommendedControlCount" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/duplicates": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_duplicates", "summary": "Find duplicate controls", "tags": [ "Controls" ], "description": "Finds controls in the organization that map to the same underlying SCF control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "key", "name" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/auditor-access": { "get": { "operationId": "get_trust_v1_organizations_organizationid_auditor_access", "summary": "List auditor access grants", "tags": [ "Controls" ], "description": "Lists the auditor access grants for the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "auditId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "frameworkNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "firmName", "frameworkNames" ], "additionalProperties": false }, "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "invitedByUserId": { "type": "string" }, "userId": { "type": "string" }, "accountId": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "active", "expired", "revoked" ] }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "invitedAt": { "type": "string" }, "activatedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "lastAccessAt": { "type": "string" }, "revokedAt": { "type": "string" }, "revokedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "organizationFrameworkIds", "auditorEmail", "invitedByUserId", "userId", "status", "permissions", "invitedAt", "expiresAt" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_auditor_access", "summary": "Invite an auditor", "tags": [ "Controls" ], "description": "Invites an external auditor to the organization and grants them access to the selected frameworks.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "auditorEmail": { "type": "string", "format": "email", "pattern": "^(?!\\.)(?!.*\\.\\.)([A-Za-z0-9_'+\\-\\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\\-]*\\.)+[A-Za-z]{2,}$" }, "organizationFrameworkIds": { "default": [], "type": "array", "items": { "type": "string" } }, "auditId": { "type": "string" }, "auditorOrgName": { "type": "string" }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } } }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "auditorEmail", "expiresAt" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "auditorAccess": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "auditId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "frameworkNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "firmName", "frameworkNames" ], "additionalProperties": false }, "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "invitedByUserId": { "type": "string" }, "userId": { "type": "string" }, "accountId": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "active", "expired", "revoked" ] }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "invitedAt": { "type": "string" }, "activatedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "lastAccessAt": { "type": "string" }, "revokedAt": { "type": "string" }, "revokedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "organizationFrameworkIds", "auditorEmail", "invitedByUserId", "userId", "status", "permissions", "invitedAt", "expiresAt" ], "additionalProperties": {} } }, "required": [ "auditorAccess" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/auditor-overview": { "get": { "operationId": "get_trust_v1_organizations_organizationid_auditor_overview", "summary": "Get the auditor overview", "tags": [ "Controls" ], "description": "Returns an activity summary for each auditor plus open requests for the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "auditors": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "active", "expired", "revoked" ] }, "activatedAt": { "type": "string" }, "lastAccessAt": { "type": "string" }, "expiresAt": { "type": "string" }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "frameworks": { "type": "array", "items": { "type": "string" } }, "controlsInScope": { "type": "number" }, "reviewed": { "type": "number" }, "byReviewStatus": { "type": "object", "properties": { "not_reviewed": { "type": "number" }, "in_review": { "type": "number" }, "accepted": { "type": "number" }, "needs_more_info": { "type": "number" }, "exception": { "type": "number" } }, "required": [ "not_reviewed", "in_review", "accepted", "needs_more_info", "exception" ], "additionalProperties": false }, "requests": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "recentComments": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "id", "auditorEmail", "status", "expiresAt", "permissions", "frameworks", "controlsInScope", "reviewed", "byReviewStatus", "requests", "recentComments" ], "additionalProperties": {} } }, "openRequests": { "type": "number" } }, "required": [ "auditors", "openRequests" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/audits": { "get": { "operationId": "get_trust_v1_organizations_organizationid_audits", "summary": "List audits", "tags": [ "Controls" ], "description": "Lists the audit engagements for the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "audits": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "frameworkNames": { "type": "array", "items": { "type": "string" } }, "auditPeriodStart": { "type": "string" }, "auditPeriodEnd": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "completed", "archived" ] }, "controlsInScope": { "type": "number" }, "reviewed": { "type": "number" }, "byReviewStatus": { "type": "object", "properties": { "not_reviewed": { "type": "number" }, "in_review": { "type": "number" }, "accepted": { "type": "number" }, "needs_more_info": { "type": "number" }, "exception": { "type": "number" } }, "required": [ "not_reviewed", "in_review", "accepted", "needs_more_info", "exception" ], "additionalProperties": false }, "auditors": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "requests": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "openRequests": { "type": "number" }, "recentComments": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "id", "firmName", "organizationFrameworkIds", "frameworkNames", "status", "controlsInScope", "reviewed", "byReviewStatus", "auditors", "requests", "openRequests", "recentComments" ], "additionalProperties": {} } } }, "required": [ "audits" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_audits", "summary": "Create an audit", "tags": [ "Controls" ], "description": "Creates a new audit engagement with a firm name, framework scope, and period.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "firmName": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "auditPeriodStart": { "type": "string" }, "auditPeriodEnd": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "completed", "archived" ] }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "firmName", "organizationFrameworkIds", "status", "createdByUserId" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/auditor-access/{auditorAccessId}/revoke": { "post": { "operationId": "post_trust_v1_organizations_organizationid_auditor_access_auditoraccessid_revoke", "summary": "Revoke auditor access", "tags": [ "Controls" ], "description": "Revokes an auditor access grant.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "auditorAccessId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "auditId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "frameworkNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "firmName", "frameworkNames" ], "additionalProperties": false }, "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "invitedByUserId": { "type": "string" }, "userId": { "type": "string" }, "accountId": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "active", "expired", "revoked" ] }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "invitedAt": { "type": "string" }, "activatedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "lastAccessAt": { "type": "string" }, "revokedAt": { "type": "string" }, "revokedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "organizationFrameworkIds", "auditorEmail", "invitedByUserId", "userId", "status", "permissions", "invitedAt", "expiresAt" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/auditor-access/{auditorAccessId}/reinstate": { "post": { "operationId": "post_trust_v1_organizations_organizationid_auditor_access_auditoraccessid_reinstate", "summary": "Reinstate auditor access", "tags": [ "Controls" ], "description": "Reinstates a previously revoked auditor access grant with a new expiry.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "auditorAccessId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "auditId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "frameworkNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "firmName", "frameworkNames" ], "additionalProperties": false }, "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "invitedByUserId": { "type": "string" }, "userId": { "type": "string" }, "accountId": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "active", "expired", "revoked" ] }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "invitedAt": { "type": "string" }, "activatedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "lastAccessAt": { "type": "string" }, "revokedAt": { "type": "string" }, "revokedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "organizationFrameworkIds", "auditorEmail", "invitedByUserId", "userId", "status", "permissions", "invitedAt", "expiresAt" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/auditor-access/{auditorAccessId}/update": { "post": { "operationId": "post_trust_v1_organizations_organizationid_auditor_access_auditoraccessid_update", "summary": "Update auditor access", "tags": [ "Controls" ], "description": "Updates the expiry, permissions, or audit assignment of an auditor access grant.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "auditorAccessId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "organizationFrameworkIds": { "type": "array", "items": { "type": "string" } }, "auditId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "frameworkNames": { "type": "array", "items": { "type": "string" } } }, "required": [ "id", "firmName", "frameworkNames" ], "additionalProperties": false }, "auditorEmail": { "type": "string" }, "auditorOrgName": { "type": "string" }, "invitedByUserId": { "type": "string" }, "userId": { "type": "string" }, "accountId": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "active", "expired", "revoked" ] }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "invitedAt": { "type": "string" }, "activatedAt": { "type": "string" }, "expiresAt": { "type": "string" }, "lastAccessAt": { "type": "string" }, "revokedAt": { "type": "string" }, "revokedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "organizationFrameworkIds", "auditorEmail", "invitedByUserId", "userId", "status", "permissions", "invitedAt", "expiresAt" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls": { "get": { "operationId": "get_trust_v1_auditor_organizationid_controls", "summary": "List controls for auditor review", "tags": [ "Auditor" ], "description": "Lists the controls within the scope of an auditor access grant for auditor review.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} } }, "total": { "type": "number" }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false } }, "required": [ "items", "total", "permissions" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/frameworks/{organizationFrameworkId}/coverage": { "get": { "operationId": "get_trust_v1_auditor_organizationid_frameworks_organizationframeworkid_coverage", "summary": "Get framework coverage for auditor review", "tags": [ "Auditor" ], "description": "Returns the control coverage of a framework for auditor review.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "organizationFrameworkId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "requirement": { "type": "object", "properties": { "id": { "type": "string" }, "externalId": { "type": "string" }, "level": { "type": "string" }, "shortName": { "type": "string" }, "category": { "type": "string" }, "description": { "type": "string" } }, "required": [ "id", "externalId", "level" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "covered", "partial", "not_covered", "not_applicable" ] }, "coveringControlIds": { "type": "array", "items": { "type": "string" } }, "mappedControls": { "type": "array", "items": { "type": "object", "properties": { "templateId": { "type": "string" }, "key": { "type": "string" }, "name": { "type": "string" }, "recommended": { "type": "boolean" }, "adopted": { "type": "boolean" }, "controlId": { "type": "string" } }, "required": [ "templateId", "key", "name", "recommended", "adopted" ], "additionalProperties": false } }, "notApplicableJustification": { "type": "string" }, "operatingStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] } }, "required": [ "requirement", "status", "coveringControlIds" ], "additionalProperties": false } }, "summary": { "type": "object", "properties": { "covered": { "type": "number" }, "partial": { "type": "number" }, "not_covered": { "type": "number" }, "not_applicable": { "type": "number" } }, "required": [ "covered", "partial", "not_covered", "not_applicable" ], "additionalProperties": false } }, "required": [ "items", "summary" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/evidence": { "get": { "operationId": "get_trust_v1_auditor_organizationid_controls_controlid_evidence", "summary": "List control evidence for auditor review", "tags": [ "Auditor" ], "description": "Lists the evidence for a control that the auditor is permitted to view.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } }, "total": { "type": "number" }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false }, "runs": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "exceptions": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "auditorRequests": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "items", "total", "permissions" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/evidence/{controlEvidenceId}/file": { "get": { "operationId": "get_trust_v1_auditor_organizationid_controls_controlid_evidence_controlevidenceid_file", "summary": "Get an evidence file URL for auditor review", "tags": [ "Auditor" ], "description": "Returns a short-lived URL for an auditor to view an uploaded evidence file.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlEvidenceId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "url" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/evidence/{controlEvidenceId}/document": { "get": { "operationId": "get_trust_v1_auditor_organizationid_controls_controlid_evidence_controlevidenceid_document", "summary": "Get an evidence document for auditor review", "tags": [ "Auditor" ], "description": "Returns the published document behind an evidence link as a file URL or rendered HTML for auditor review.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlEvidenceId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "file", "html" ] }, "name": { "type": "string" }, "version": { "type": "number" }, "url": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "body": { "type": "string" } }, "required": [ "kind", "name" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/review": { "put": { "operationId": "put_trust_v1_auditor_organizationid_controls_controlid_review", "summary": "Set an auditor review verdict", "tags": [ "Auditor" ], "description": "Records the auditor verdict for a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "auditorAccessId": { "type": "string" }, "controlId": { "type": "string" }, "reviewStatus": { "type": "string", "enum": [ "not_reviewed", "in_review", "accepted", "needs_more_info", "exception" ] }, "updatedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "auditorAccessId", "controlId", "reviewStatus" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/comments": { "get": { "operationId": "get_trust_v1_auditor_organizationid_controls_controlid_comments", "summary": "List control comments for auditor review", "tags": [ "Auditor" ], "description": "Lists the discussion comments on a control that the auditor is permitted to view.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "type": "string", "enum": [ "control" ] }, "referenceId": { "type": "string" }, "authorType": { "type": "string", "enum": [ "user", "auditor" ] }, "authorId": { "type": "string" }, "authorName": { "type": "string" }, "body": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "type", "referenceId", "authorType", "authorId", "body" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_auditor_organizationid_controls_controlid_comments", "summary": "Add an auditor comment", "tags": [ "Auditor" ], "description": "Adds an auditor comment to the discussion thread on a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "type": { "type": "string", "enum": [ "control" ] }, "referenceId": { "type": "string" }, "authorType": { "type": "string", "enum": [ "user", "auditor" ] }, "authorId": { "type": "string" }, "authorName": { "type": "string" }, "body": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "type", "referenceId", "authorType", "authorId", "body" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/requests": { "post": { "operationId": "post_trust_v1_auditor_organizationid_controls_controlid_requests", "summary": "Request evidence from the auditee", "tags": [ "Auditor" ], "description": "Creates a task asking the organization for evidence on a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "control", "requirement_gap", "privacy_request", "data_system", "compliance_scan", "tracker_scan", "gcm_scan", "risk", "vendor", "assessment" ] }, "referenceId": { "type": "string" }, "organizationFrameworkId": { "type": "string" }, "projectId": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "assigneeType": {}, "assigneeId": {}, "assignedByUserId": {}, "assignedAt": {}, "statusCategory": { "type": "string", "enum": [ "backlog", "todo", "in_progress", "done", "cancelled" ] }, "status": { "type": "string" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ] }, "dueAt": { "type": "string" }, "blockedBy": { "type": "array", "items": { "type": "string" } }, "blockedReason": { "type": "string" }, "source": { "type": "string", "enum": [ "manual", "test", "integration", "system", "agent", "auditor" ] }, "originRef": { "type": "string" }, "createdByType": { "type": "string", "enum": [ "user", "agent", "system", "apikey" ] }, "createdById": { "type": "string" }, "completedAt": { "type": "string" }, "completedByType": { "type": "string", "enum": [ "user", "agent", "system", "apikey" ] }, "completedById": { "type": "string" }, "cancelReason": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "title", "assigneeType", "assigneeId", "assignedByUserId", "assignedAt", "statusCategory", "status", "priority", "source", "createdByType", "createdById" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/requirements": { "get": { "operationId": "get_trust_v1_auditor_organizationid_controls_controlid_requirements", "summary": "List control requirements for auditor review", "tags": [ "Auditor" ], "description": "Lists control requirements for auditor review.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "externalId": { "type": "string" }, "description": { "type": "string" }, "level": { "type": "string" }, "frameworkShortName": { "type": "string" }, "organizationFrameworkId": { "type": "string" } }, "required": [ "externalId" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/controls/{controlId}/requests/{taskId}/withdraw": { "post": { "operationId": "post_trust_v1_auditor_organizationid_controls_controlid_requests_taskid_withdraw", "summary": "Withdraw an evidence request", "tags": [ "Auditor" ], "description": "Withdraws an evidence request the auditor previously created for a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "taskId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "string", "enum": [ "control", "requirement_gap", "privacy_request", "data_system", "compliance_scan", "tracker_scan", "gcm_scan", "risk", "vendor", "assessment" ] }, "referenceId": { "type": "string" }, "organizationFrameworkId": { "type": "string" }, "projectId": { "type": "string" }, "labels": { "type": "array", "items": { "type": "string" } }, "assigneeType": {}, "assigneeId": {}, "assignedByUserId": {}, "assignedAt": {}, "statusCategory": { "type": "string", "enum": [ "backlog", "todo", "in_progress", "done", "cancelled" ] }, "status": { "type": "string" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ] }, "dueAt": { "type": "string" }, "blockedBy": { "type": "array", "items": { "type": "string" } }, "blockedReason": { "type": "string" }, "source": { "type": "string", "enum": [ "manual", "test", "integration", "system", "agent", "auditor" ] }, "originRef": { "type": "string" }, "createdByType": { "type": "string", "enum": [ "user", "agent", "system", "apikey" ] }, "createdById": { "type": "string" }, "completedAt": { "type": "string" }, "completedByType": { "type": "string", "enum": [ "user", "agent", "system", "apikey" ] }, "completedById": { "type": "string" }, "cancelReason": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "title", "assigneeType", "assigneeId", "assignedByUserId", "assignedAt", "statusCategory", "status", "priority", "source", "createdByType", "createdById" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/auditor/{organizationId}/summary": { "get": { "operationId": "get_trust_v1_auditor_organizationid_summary", "summary": "Get the auditor summary", "tags": [ "Auditor" ], "description": "Returns a dashboard summary of auditor access and activity in the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "controlsInScope": { "type": "number" }, "reviewed": { "type": "number" }, "byReviewStatus": { "type": "object", "properties": { "not_reviewed": { "type": "number" }, "in_review": { "type": "number" }, "accepted": { "type": "number" }, "needs_more_info": { "type": "number" }, "exception": { "type": "number" } }, "required": [ "not_reviewed", "in_review", "accepted", "needs_more_info", "exception" ], "additionalProperties": false }, "openRequests": { "type": "number" }, "requests": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "recentComments": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, "auditPeriod": { "type": "object", "properties": { "start": { "type": "string" }, "end": { "type": "string" } }, "additionalProperties": false }, "frameworks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "coverage": { "type": "object", "properties": { "covered": { "type": "number" }, "partial": { "type": "number" }, "not_covered": { "type": "number" }, "not_applicable": { "type": "number" } }, "required": [ "covered", "partial", "not_covered", "not_applicable" ], "additionalProperties": false }, "permissions": { "type": "object", "properties": { "canExport": { "type": "boolean" }, "canComment": { "type": "boolean" }, "canViewDocuments": { "type": "boolean" } }, "required": [ "canExport", "canComment", "canViewDocuments" ], "additionalProperties": false } }, "required": [ "controlsInScope", "reviewed", "byReviewStatus", "openRequests", "requests", "recentComments", "auditPeriod", "frameworks", "coverage", "permissions" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects", "summary": "Create a trust center", "tags": [ "Trust Centers" ], "description": "Creates a new trust center for an organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 63 }, "enabled": { "type": "boolean" }, "overview": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 10000 }, "contactEmail": { "type": "string", "format": "email" }, "privacyPolicyUrl": { "type": "string", "format": "uri" } }, "additionalProperties": false }, "sections": { "type": "object", "properties": { "compliance": { "type": "boolean" }, "resources": { "type": "boolean" }, "faq": { "type": "boolean" } }, "additionalProperties": false }, "includedDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "documentCategoryOverrides": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "documentCategory": { "type": "string", "enum": [ "certificates", "documentation", "policies", "reports", "other" ] } }, "required": [ "documentId", "documentCategory" ], "additionalProperties": false } }, "branding": { "type": "object", "properties": { "logoUrl": { "type": "string", "maxLength": 524288 }, "iconUrl": { "type": "string", "maxLength": 524288 }, "primaryColor": { "type": "string", "maxLength": 64 }, "secondaryColor": { "type": "string", "maxLength": 64 }, "font": { "type": "string", "maxLength": 256 }, "buttonRadius": { "type": "string", "maxLength": 64 }, "cardRadius": { "type": "string", "maxLength": 64 } }, "additionalProperties": false }, "theme": { "type": "string", "enum": [ "light", "dark" ] }, "requireNda": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" } }, "required": [ "name", "slug" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 63 }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "overview": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 10000 }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "title", "description" ], "additionalProperties": false }, "sections": { "type": "object", "properties": { "compliance": { "type": "boolean" }, "resources": { "type": "boolean" }, "faq": { "type": "boolean" }, "announcements": { "type": "boolean" }, "controls": { "type": "boolean" }, "subProcessors": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "compliance", "resources", "faq" ], "additionalProperties": false }, "sectionLayout": { "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "compliance", "resources", "faq", "announcements", "subProcessors", "controls" ] }, "width": { "type": "string", "enum": [ "1/3", "1/2", "2/3", "full" ] }, "label": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "showInNav": { "type": "boolean" } }, "required": [ "key", "width" ], "additionalProperties": false } }, "includedDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "documentCategoryOverrides": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "documentCategory": { "type": "string", "enum": [ "certificates", "documentation", "policies", "reports", "other" ] } }, "required": [ "documentId", "documentCategory" ], "additionalProperties": false } }, "publicControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "aiControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "controlsShowInProgress": { "type": "boolean" }, "subProcessorRefs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "vendor" ] }, "id": { "type": "string", "format": "uuid" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "branding": { "type": "object", "properties": { "logoUrl": { "type": "string" }, "iconUrl": { "type": "string" }, "primaryColor": { "type": "string", "maxLength": 64 }, "secondaryColor": { "type": "string", "maxLength": 64 }, "font": { "type": "string", "maxLength": 256 }, "buttonRadius": { "type": "string", "maxLength": 64 }, "cardRadius": { "type": "string", "maxLength": 64 }, "template": { "type": "string", "default": "compact", "enum": [ "compact", "spotlight" ] }, "ctas": { "type": "array", "default": [ { "id": "requestAccess", "enabled": true }, { "id": "email", "enabled": true }, { "id": "subscribe", "enabled": true } ], "maxItems": 3, "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "requestAccess", "email", "subscribe" ] }, "enabled": { "type": "boolean" }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "maxLength": 254, "format": "email" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] } }, "required": [ "id", "enabled" ], "additionalProperties": false } }, "quickLinks": { "type": "array", "default": [], "maxItems": 12, "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 128 }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "format": "uri" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "label", "url", "icon", "enabled" ], "additionalProperties": false } }, "quickLinksPlacement": { "type": "string", "default": "sidebar", "enum": [ "sidebar", "below" ] }, "heroBackground": { "oneOf": [ { "type": "object" } ] }, "hideComplianceBadgeArt": { "type": "boolean", "default": false }, "stylizedTitle": { "type": "boolean" }, "heroEyebrow": { "type": "string", "default": "Live Sync Enabled", "maxLength": 60 }, "heroEyebrowEnabled": { "type": "boolean", "default": true }, "documentCategoryIcons": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false }, "hideDocumentCategoryIcons": { "type": "boolean", "default": false }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "textSize": { "type": "string", "enum": [ "sm", "md", "lg" ] }, "accessDurationDays": { "type": "integer", "minimum": 1, "maximum": 730 }, "autoDenyAfterDays": { "oneOf": [ { "type": "integer" } ] }, "blockFreeEmailDomains": { "type": "boolean" }, "blockDisposableEmailDomains": { "type": "boolean" }, "requireNda": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaSigningRequirement": { "type": "string", "enum": [ "none", "every_user", "first_per_connection" ] }, "ndaConfirmationEmail": { "type": "boolean" }, "notifyOnAccess": { "type": "boolean" }, "notificationEmails": { "type": "array", "maxItems": 10, "items": { "type": "string", "format": "email" } }, "sendFromEmailId": { "type": "string", "format": "uuid" }, "customDomain": { "type": "string", "maxLength": 256 }, "customDomainVerified": { "type": "boolean" }, "customDomainCloudflareId": { "type": "string", "maxLength": 256 }, "customDomainFailureReason": { "oneOf": [ { "type": "string" } ] }, "customDomainDnsValidationCnames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "value" ], "additionalProperties": false } }, "customDomainStatus": { "type": "string", "enum": [ "pending", "cert_pending", "active", "failed" ] }, "platformHostnameCloudflareId": { "type": "string", "maxLength": 256 }, "platformHostnameStatus": { "type": "string", "enum": [ "cert_pending", "active", "failed" ] }, "platformHostnameFailureReason": { "oneOf": [ { "type": "string" } ] }, "ragChatEnabled": { "type": "boolean" }, "ragChatAudience": { "type": "string", "enum": [ "public", "restricted" ] }, "ragChatPosition": { "type": "string", "enum": [ "bottom-right", "bottom-left" ] }, "ragChatTheme": { "type": "string", "enum": [ "light", "dark", "auto" ] }, "ragChatIcon": { "type": "string", "enum": [ "chat", "chat-circle", "chat-text", "question", "sparkle", "head-circuit" ] }, "ragChatAccentColor": { "type": "string", "maxLength": 64 }, "ragChatOffsetX": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatOffsetY": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatFallbackText": { "type": "string", "maxLength": 500 }, "ragKnowledgeBaseDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "ragModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragQuestionnaireModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragRfpModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragMemorySuggestionModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragKnowledgeBaseLastIndexedAt": { "type": "string", "format": "date-time" }, "selfLearning": { "type": "object", "properties": { "indexApprovedAnswers": { "type": "boolean" }, "suggestMemoryEdits": { "type": "boolean" }, "approvedAnswerTtlMonths": { "type": "integer", "minimum": 0, "maximum": 60 } }, "additionalProperties": false }, "customScript": { "type": "string", "maxLength": 50000 }, "linkedPrivacyProjectId": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "slug", "enabled", "overview", "sections", "includedDocumentIds", "branding", "theme", "requireNda", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_projects", "summary": "List trust centers", "tags": [ "Trust Centers" ], "description": "Lists trust centers for an organization with pagination.", "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "enabled", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "countOnly", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 63 }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "overview": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 10000 }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "title", "description" ], "additionalProperties": false }, "sections": { "type": "object", "properties": { "compliance": { "type": "boolean" }, "resources": { "type": "boolean" }, "faq": { "type": "boolean" }, "announcements": { "type": "boolean" }, "controls": { "type": "boolean" }, "subProcessors": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "compliance", "resources", "faq" ], "additionalProperties": false }, "sectionLayout": { "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "compliance", "resources", "faq", "announcements", "subProcessors", "controls" ] }, "width": { "type": "string", "enum": [ "1/3", "1/2", "2/3", "full" ] }, "label": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "showInNav": { "type": "boolean" } }, "required": [ "key", "width" ], "additionalProperties": false } }, "includedDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "documentCategoryOverrides": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "documentCategory": { "type": "string", "enum": [ "certificates", "documentation", "policies", "reports", "other" ] } }, "required": [ "documentId", "documentCategory" ], "additionalProperties": false } }, "publicControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "aiControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "controlsShowInProgress": { "type": "boolean" }, "subProcessorRefs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "vendor" ] }, "id": { "type": "string", "format": "uuid" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "branding": { "type": "object", "properties": { "logoUrl": { "type": "string" }, "iconUrl": { "type": "string" }, "primaryColor": { "type": "string", "maxLength": 64 }, "secondaryColor": { "type": "string", "maxLength": 64 }, "font": { "type": "string", "maxLength": 256 }, "buttonRadius": { "type": "string", "maxLength": 64 }, "cardRadius": { "type": "string", "maxLength": 64 }, "template": { "type": "string", "default": "compact", "enum": [ "compact", "spotlight" ] }, "ctas": { "type": "array", "default": [ { "id": "requestAccess", "enabled": true }, { "id": "email", "enabled": true }, { "id": "subscribe", "enabled": true } ], "maxItems": 3, "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "requestAccess", "email", "subscribe" ] }, "enabled": { "type": "boolean" }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "maxLength": 254, "format": "email" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] } }, "required": [ "id", "enabled" ], "additionalProperties": false } }, "quickLinks": { "type": "array", "default": [], "maxItems": 12, "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 128 }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "format": "uri" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "label", "url", "icon", "enabled" ], "additionalProperties": false } }, "quickLinksPlacement": { "type": "string", "default": "sidebar", "enum": [ "sidebar", "below" ] }, "heroBackground": { "oneOf": [ { "type": "object" } ] }, "hideComplianceBadgeArt": { "type": "boolean", "default": false }, "stylizedTitle": { "type": "boolean" }, "heroEyebrow": { "type": "string", "default": "Live Sync Enabled", "maxLength": 60 }, "heroEyebrowEnabled": { "type": "boolean", "default": true }, "documentCategoryIcons": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false }, "hideDocumentCategoryIcons": { "type": "boolean", "default": false }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "textSize": { "type": "string", "enum": [ "sm", "md", "lg" ] }, "accessDurationDays": { "type": "integer", "minimum": 1, "maximum": 730 }, "autoDenyAfterDays": { "oneOf": [ { "type": "integer" } ] }, "blockFreeEmailDomains": { "type": "boolean" }, "blockDisposableEmailDomains": { "type": "boolean" }, "requireNda": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaSigningRequirement": { "type": "string", "enum": [ "none", "every_user", "first_per_connection" ] }, "ndaConfirmationEmail": { "type": "boolean" }, "notifyOnAccess": { "type": "boolean" }, "notificationEmails": { "type": "array", "maxItems": 10, "items": { "type": "string", "format": "email" } }, "sendFromEmailId": { "type": "string", "format": "uuid" }, "customDomain": { "type": "string", "maxLength": 256 }, "customDomainVerified": { "type": "boolean" }, "customDomainCloudflareId": { "type": "string", "maxLength": 256 }, "customDomainFailureReason": { "oneOf": [ { "type": "string" } ] }, "customDomainDnsValidationCnames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "value" ], "additionalProperties": false } }, "customDomainStatus": { "type": "string", "enum": [ "pending", "cert_pending", "active", "failed" ] }, "platformHostnameCloudflareId": { "type": "string", "maxLength": 256 }, "platformHostnameStatus": { "type": "string", "enum": [ "cert_pending", "active", "failed" ] }, "platformHostnameFailureReason": { "oneOf": [ { "type": "string" } ] }, "ragChatEnabled": { "type": "boolean" }, "ragChatAudience": { "type": "string", "enum": [ "public", "restricted" ] }, "ragChatPosition": { "type": "string", "enum": [ "bottom-right", "bottom-left" ] }, "ragChatTheme": { "type": "string", "enum": [ "light", "dark", "auto" ] }, "ragChatIcon": { "type": "string", "enum": [ "chat", "chat-circle", "chat-text", "question", "sparkle", "head-circuit" ] }, "ragChatAccentColor": { "type": "string", "maxLength": 64 }, "ragChatOffsetX": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatOffsetY": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatFallbackText": { "type": "string", "maxLength": 500 }, "ragKnowledgeBaseDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "ragModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragQuestionnaireModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragRfpModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragMemorySuggestionModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragKnowledgeBaseLastIndexedAt": { "type": "string", "format": "date-time" }, "selfLearning": { "type": "object", "properties": { "indexApprovedAnswers": { "type": "boolean" }, "suggestMemoryEdits": { "type": "boolean" }, "approvedAnswerTtlMonths": { "type": "integer", "minimum": 0, "maximum": 60 } }, "additionalProperties": false }, "customScript": { "type": "string", "maxLength": 50000 }, "linkedPrivacyProjectId": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "slug", "enabled", "overview", "sections", "includedDocumentIds", "branding", "theme", "requireNda", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid", "summary": "Get a trust center", "tags": [ "Trust Centers" ], "description": "Gets a single trust center by ID.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 63 }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "overview": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 10000 }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "title", "description" ], "additionalProperties": false }, "sections": { "type": "object", "properties": { "compliance": { "type": "boolean" }, "resources": { "type": "boolean" }, "faq": { "type": "boolean" }, "announcements": { "type": "boolean" }, "controls": { "type": "boolean" }, "subProcessors": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "compliance", "resources", "faq" ], "additionalProperties": false }, "sectionLayout": { "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "compliance", "resources", "faq", "announcements", "subProcessors", "controls" ] }, "width": { "type": "string", "enum": [ "1/3", "1/2", "2/3", "full" ] }, "label": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "showInNav": { "type": "boolean" } }, "required": [ "key", "width" ], "additionalProperties": false } }, "includedDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "documentCategoryOverrides": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "documentCategory": { "type": "string", "enum": [ "certificates", "documentation", "policies", "reports", "other" ] } }, "required": [ "documentId", "documentCategory" ], "additionalProperties": false } }, "publicControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "aiControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "controlsShowInProgress": { "type": "boolean" }, "subProcessorRefs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "vendor" ] }, "id": { "type": "string", "format": "uuid" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "branding": { "type": "object", "properties": { "logoUrl": { "type": "string" }, "iconUrl": { "type": "string" }, "primaryColor": { "type": "string", "maxLength": 64 }, "secondaryColor": { "type": "string", "maxLength": 64 }, "font": { "type": "string", "maxLength": 256 }, "buttonRadius": { "type": "string", "maxLength": 64 }, "cardRadius": { "type": "string", "maxLength": 64 }, "template": { "type": "string", "default": "compact", "enum": [ "compact", "spotlight" ] }, "ctas": { "type": "array", "default": [ { "id": "requestAccess", "enabled": true }, { "id": "email", "enabled": true }, { "id": "subscribe", "enabled": true } ], "maxItems": 3, "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "requestAccess", "email", "subscribe" ] }, "enabled": { "type": "boolean" }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "maxLength": 254, "format": "email" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] } }, "required": [ "id", "enabled" ], "additionalProperties": false } }, "quickLinks": { "type": "array", "default": [], "maxItems": 12, "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 128 }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "format": "uri" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "label", "url", "icon", "enabled" ], "additionalProperties": false } }, "quickLinksPlacement": { "type": "string", "default": "sidebar", "enum": [ "sidebar", "below" ] }, "heroBackground": { "oneOf": [ { "type": "object" } ] }, "hideComplianceBadgeArt": { "type": "boolean", "default": false }, "stylizedTitle": { "type": "boolean" }, "heroEyebrow": { "type": "string", "default": "Live Sync Enabled", "maxLength": 60 }, "heroEyebrowEnabled": { "type": "boolean", "default": true }, "documentCategoryIcons": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false }, "hideDocumentCategoryIcons": { "type": "boolean", "default": false }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "textSize": { "type": "string", "enum": [ "sm", "md", "lg" ] }, "accessDurationDays": { "type": "integer", "minimum": 1, "maximum": 730 }, "autoDenyAfterDays": { "oneOf": [ { "type": "integer" } ] }, "blockFreeEmailDomains": { "type": "boolean" }, "blockDisposableEmailDomains": { "type": "boolean" }, "requireNda": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaSigningRequirement": { "type": "string", "enum": [ "none", "every_user", "first_per_connection" ] }, "ndaConfirmationEmail": { "type": "boolean" }, "notifyOnAccess": { "type": "boolean" }, "notificationEmails": { "type": "array", "maxItems": 10, "items": { "type": "string", "format": "email" } }, "sendFromEmailId": { "type": "string", "format": "uuid" }, "customDomain": { "type": "string", "maxLength": 256 }, "customDomainVerified": { "type": "boolean" }, "customDomainCloudflareId": { "type": "string", "maxLength": 256 }, "customDomainFailureReason": { "oneOf": [ { "type": "string" } ] }, "customDomainDnsValidationCnames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "value" ], "additionalProperties": false } }, "customDomainStatus": { "type": "string", "enum": [ "pending", "cert_pending", "active", "failed" ] }, "platformHostnameCloudflareId": { "type": "string", "maxLength": 256 }, "platformHostnameStatus": { "type": "string", "enum": [ "cert_pending", "active", "failed" ] }, "platformHostnameFailureReason": { "oneOf": [ { "type": "string" } ] }, "ragChatEnabled": { "type": "boolean" }, "ragChatAudience": { "type": "string", "enum": [ "public", "restricted" ] }, "ragChatPosition": { "type": "string", "enum": [ "bottom-right", "bottom-left" ] }, "ragChatTheme": { "type": "string", "enum": [ "light", "dark", "auto" ] }, "ragChatIcon": { "type": "string", "enum": [ "chat", "chat-circle", "chat-text", "question", "sparkle", "head-circuit" ] }, "ragChatAccentColor": { "type": "string", "maxLength": 64 }, "ragChatOffsetX": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatOffsetY": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatFallbackText": { "type": "string", "maxLength": 500 }, "ragKnowledgeBaseDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "ragModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragQuestionnaireModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragRfpModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragMemorySuggestionModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragKnowledgeBaseLastIndexedAt": { "type": "string", "format": "date-time" }, "selfLearning": { "type": "object", "properties": { "indexApprovedAnswers": { "type": "boolean" }, "suggestMemoryEdits": { "type": "boolean" }, "approvedAnswerTtlMonths": { "type": "integer", "minimum": 0, "maximum": 60 } }, "additionalProperties": false }, "customScript": { "type": "string", "maxLength": 50000 }, "linkedPrivacyProjectId": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "slug", "enabled", "overview", "sections", "includedDocumentIds", "branding", "theme", "requireNda", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid", "summary": "Update a trust center", "tags": [ "Trust Centers" ], "description": "Updates a trust center using JSON Patch operations.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 63 }, "enabled": { "type": "boolean" }, "isDefault": { "type": "boolean" }, "overview": { "type": "object", "properties": { "title": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 10000 }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "title", "description" ], "additionalProperties": false }, "sections": { "type": "object", "properties": { "compliance": { "type": "boolean" }, "resources": { "type": "boolean" }, "faq": { "type": "boolean" }, "announcements": { "type": "boolean" }, "controls": { "type": "boolean" }, "subProcessors": { "type": "boolean" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "required": [ "compliance", "resources", "faq" ], "additionalProperties": false }, "sectionLayout": { "type": "array", "maxItems": 10, "items": { "type": "object", "properties": { "key": { "type": "string", "enum": [ "compliance", "resources", "faq", "announcements", "subProcessors", "controls" ] }, "width": { "type": "string", "enum": [ "1/3", "1/2", "2/3", "full" ] }, "label": { "type": "string", "maxLength": 120 }, "description": { "type": "string", "maxLength": 300 }, "showInNav": { "type": "boolean" } }, "required": [ "key", "width" ], "additionalProperties": false } }, "includedDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "documentCategoryOverrides": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" }, "documentCategory": { "type": "string", "enum": [ "certificates", "documentation", "policies", "reports", "other" ] } }, "required": [ "documentId", "documentCategory" ], "additionalProperties": false } }, "publicControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "aiControlIds": { "type": "array", "maxItems": 1000, "items": { "type": "string" } }, "controlsShowInProgress": { "type": "boolean" }, "subProcessorRefs": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "vendor" ] }, "id": { "type": "string", "format": "uuid" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "branding": { "type": "object", "properties": { "logoUrl": { "type": "string" }, "iconUrl": { "type": "string" }, "primaryColor": { "type": "string", "maxLength": 64 }, "secondaryColor": { "type": "string", "maxLength": 64 }, "font": { "type": "string", "maxLength": 256 }, "buttonRadius": { "type": "string", "maxLength": 64 }, "cardRadius": { "type": "string", "maxLength": 64 }, "template": { "type": "string", "default": "compact", "enum": [ "compact", "spotlight" ] }, "ctas": { "type": "array", "default": [ { "id": "requestAccess", "enabled": true }, { "id": "email", "enabled": true }, { "id": "subscribe", "enabled": true } ], "maxItems": 3, "uniqueItems": true, "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "requestAccess", "email", "subscribe" ] }, "enabled": { "type": "boolean" }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "maxLength": 254, "format": "email" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] } }, "required": [ "id", "enabled" ], "additionalProperties": false } }, "quickLinks": { "type": "array", "default": [], "maxItems": 12, "items": { "type": "object", "properties": { "id": { "type": "string", "maxLength": 128 }, "label": { "type": "string", "maxLength": 80 }, "url": { "type": "string", "format": "uri" }, "icon": { "type": "string", "enum": [ "none", "globe", "shield-check", "scales", "certificate", "file-text", "lock-key", "pulse", "info", "book", "link", "envelope", "gavel", "key", "bell" ] }, "enabled": { "type": "boolean" } }, "required": [ "id", "label", "url", "icon", "enabled" ], "additionalProperties": false } }, "quickLinksPlacement": { "type": "string", "default": "sidebar", "enum": [ "sidebar", "below" ] }, "heroBackground": { "oneOf": [ { "type": "object" } ] }, "hideComplianceBadgeArt": { "type": "boolean", "default": false }, "stylizedTitle": { "type": "boolean" }, "heroEyebrow": { "type": "string", "default": "Live Sync Enabled", "maxLength": 60 }, "heroEyebrowEnabled": { "type": "boolean", "default": true }, "documentCategoryIcons": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false }, "hideDocumentCategoryIcons": { "type": "boolean", "default": false }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" } }, "additionalProperties": false }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "textSize": { "type": "string", "enum": [ "sm", "md", "lg" ] }, "accessDurationDays": { "type": "integer", "minimum": 1, "maximum": 730 }, "autoDenyAfterDays": { "oneOf": [ { "type": "integer" } ] }, "blockFreeEmailDomains": { "type": "boolean" }, "blockDisposableEmailDomains": { "type": "boolean" }, "requireNda": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaSigningRequirement": { "type": "string", "enum": [ "none", "every_user", "first_per_connection" ] }, "ndaConfirmationEmail": { "type": "boolean" }, "notifyOnAccess": { "type": "boolean" }, "notificationEmails": { "type": "array", "maxItems": 10, "items": { "type": "string", "format": "email" } }, "sendFromEmailId": { "type": "string", "format": "uuid" }, "customDomain": { "type": "string", "maxLength": 256 }, "customDomainVerified": { "type": "boolean" }, "customDomainCloudflareId": { "type": "string", "maxLength": 256 }, "customDomainFailureReason": { "oneOf": [ { "type": "string" } ] }, "customDomainDnsValidationCnames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "value" ], "additionalProperties": false } }, "customDomainStatus": { "type": "string", "enum": [ "pending", "cert_pending", "active", "failed" ] }, "platformHostnameCloudflareId": { "type": "string", "maxLength": 256 }, "platformHostnameStatus": { "type": "string", "enum": [ "cert_pending", "active", "failed" ] }, "platformHostnameFailureReason": { "oneOf": [ { "type": "string" } ] }, "ragChatEnabled": { "type": "boolean" }, "ragChatAudience": { "type": "string", "enum": [ "public", "restricted" ] }, "ragChatPosition": { "type": "string", "enum": [ "bottom-right", "bottom-left" ] }, "ragChatTheme": { "type": "string", "enum": [ "light", "dark", "auto" ] }, "ragChatIcon": { "type": "string", "enum": [ "chat", "chat-circle", "chat-text", "question", "sparkle", "head-circuit" ] }, "ragChatAccentColor": { "type": "string", "maxLength": 64 }, "ragChatOffsetX": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatOffsetY": { "type": "integer", "minimum": 0, "maximum": 200 }, "ragChatFallbackText": { "type": "string", "maxLength": 500 }, "ragKnowledgeBaseDocumentIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "ragModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragQuestionnaireModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragRfpModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragMemorySuggestionModelId": { "type": "string", "enum": [ "meta.llama4-scout-17b-instruct-v1:0", "amazon.nova-2-lite-v1:0", "anthropic.claude-haiku-4-5-20251001-v1:0", "" ], "maxLength": 256 }, "ragKnowledgeBaseLastIndexedAt": { "type": "string", "format": "date-time" }, "selfLearning": { "type": "object", "properties": { "indexApprovedAnswers": { "type": "boolean" }, "suggestMemoryEdits": { "type": "boolean" }, "approvedAnswerTtlMonths": { "type": "integer", "minimum": 0, "maximum": 60 } }, "additionalProperties": false }, "customScript": { "type": "string", "maxLength": 50000 }, "linkedPrivacyProjectId": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "slug", "enabled", "overview", "sections", "includedDocumentIds", "branding", "theme", "requireNda", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid", "summary": "Delete a trust center", "tags": [ "Trust Centers" ], "description": "Deletes a trust center and all associated data.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/badges": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_badges", "summary": "Create a compliance badge", "tags": [ "Trust Centers" ], "description": "Creates a new compliance badge for a trust center.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "framework": { "type": "string", "maxLength": 256 }, "description": { "type": "string", "maxLength": 5000 }, "iconUrl": { "type": "string", "maxLength": 2048 }, "presetArt": { "type": "string", "enum": [ "globe", "triple", "shield", "health", "california", "disc" ] }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "certificationStatus": { "type": "string", "enum": [ "in_progress", "certified" ] }, "certificationStyle": { "type": "string", "enum": [ "neutral", "brand" ] }, "certificateDocumentId": { "type": "string", "format": "uuid" }, "issueDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "inactive" ] } }, "required": [ "name", "framework" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "framework": { "type": "string", "maxLength": 256 }, "description": { "type": "string", "maxLength": 5000 }, "iconUrl": { "type": "string", "maxLength": 2048 }, "presetArt": { "type": "string", "enum": [ "globe", "triple", "shield", "health", "california", "disc" ] }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "certificationStatus": { "type": "string", "enum": [ "in_progress", "certified" ] }, "certificationStyle": { "type": "string", "enum": [ "neutral", "brand" ] }, "certificateDocumentId": { "type": "string", "format": "uuid" }, "issueDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "name", "framework", "sortOrder", "status", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_badges", "summary": "List compliance badges", "tags": [ "Trust Centers" ], "description": "Lists compliance badges for a trust center.", "parameters": [ { "schema": { "type": "string", "enum": [ "active", "inactive" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "framework", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "countOnly", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "framework": { "type": "string", "maxLength": 256 }, "description": { "type": "string", "maxLength": 5000 }, "iconUrl": { "type": "string", "maxLength": 2048 }, "presetArt": { "type": "string", "enum": [ "globe", "triple", "shield", "health", "california", "disc" ] }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "certificationStatus": { "type": "string", "enum": [ "in_progress", "certified" ] }, "certificationStyle": { "type": "string", "enum": [ "neutral", "brand" ] }, "certificateDocumentId": { "type": "string", "format": "uuid" }, "issueDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "name", "framework", "sortOrder", "status", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/badges/{badgeId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_badges_badgeid", "summary": "Update a compliance badge", "tags": [ "Trust Centers" ], "description": "Updates a compliance badge using JSON Patch operations.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "badgeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "framework": { "type": "string", "maxLength": 256 }, "description": { "type": "string", "maxLength": 5000 }, "iconUrl": { "type": "string", "maxLength": 2048 }, "presetArt": { "type": "string", "enum": [ "globe", "triple", "shield", "health", "california", "disc" ] }, "theme": { "type": "string", "enum": [ "light", "dark", "brand" ] }, "certificationStatus": { "type": "string", "enum": [ "in_progress", "certified" ] }, "certificationStyle": { "type": "string", "enum": [ "neutral", "brand" ] }, "certificateDocumentId": { "type": "string", "format": "uuid" }, "issueDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" }, "sortOrder": { "type": "integer" }, "status": { "type": "string", "enum": [ "active", "inactive" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "name", "framework", "sortOrder", "status", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_badges_badgeid", "summary": "Delete a compliance badge", "tags": [ "Trust Centers" ], "description": "Deletes a compliance badge by ID.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "badgeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/access-requests": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_audience_access_requests", "summary": "List access requests", "tags": [ "Trust Centers" ], "description": "Lists access requests for a trust center with filtering.", "parameters": [ { "schema": { "type": "string", "enum": [ "pending", "approved", "denied" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "format": "email" }, "in": "query", "name": "requesterEmail", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "accessRequestId", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "countOnly", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "requesterName": { "type": "string", "maxLength": 1024 }, "requesterEmail": { "type": "string", "format": "email" }, "requesterCompany": { "type": "string", "maxLength": 1024 }, "reason": { "type": "string", "maxLength": 5000 }, "status": { "type": "string", "enum": [ "awaiting_verification", "pending", "approved", "denied" ] }, "approvalType": { "type": "string", "enum": [ "manual", "auto_domain", "auto_email", "invitation", "returning" ] }, "processedBy": { "type": "string", "maxLength": 1024 }, "audienceEmailId": { "type": "string", "format": "uuid" }, "audienceDomainId": { "type": "string", "format": "uuid" }, "reviewedBy": { "type": "string", "maxLength": 1024 }, "reviewedAt": { "type": "string", "format": "date-time" }, "extendedAt": { "type": "string", "format": "date-time" }, "accessToken": { "type": "string" }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "tokenUsedAt": { "type": "string", "format": "date-time" }, "ndaRequired": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaStatus": { "type": "string", "enum": [ "not_required", "pending", "signed", "bypassed" ] }, "ndaSignedAt": { "type": "string", "format": "date-time" }, "signedNdaReleaseId": { "oneOf": [ { "type": "string" } ] }, "signedNdaContentHash": { "oneOf": [ { "type": "string" } ] }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationToken": { "type": "string" }, "verificationTokenExpiresAt": { "type": "string", "format": "date-time" }, "emailSubscribed": { "type": "boolean" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "requesterName", "requesterEmail", "status", "ndaRequired", "ndaStatus", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/access-requests/{accessRequestId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_audience_access_requests_accessrequestid", "summary": "Update an access request", "tags": [ "Trust Centers" ], "description": "Updates an access request (approve/deny) using JSON Patch operations.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "accessRequestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "requesterName": { "type": "string", "maxLength": 1024 }, "requesterEmail": { "type": "string", "format": "email" }, "requesterCompany": { "type": "string", "maxLength": 1024 }, "reason": { "type": "string", "maxLength": 5000 }, "status": { "type": "string", "enum": [ "awaiting_verification", "pending", "approved", "denied" ] }, "approvalType": { "type": "string", "enum": [ "manual", "auto_domain", "auto_email", "invitation", "returning" ] }, "processedBy": { "type": "string", "maxLength": 1024 }, "audienceEmailId": { "type": "string", "format": "uuid" }, "audienceDomainId": { "type": "string", "format": "uuid" }, "reviewedBy": { "type": "string", "maxLength": 1024 }, "reviewedAt": { "type": "string", "format": "date-time" }, "extendedAt": { "type": "string", "format": "date-time" }, "accessToken": { "type": "string" }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "tokenUsedAt": { "type": "string", "format": "date-time" }, "ndaRequired": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaStatus": { "type": "string", "enum": [ "not_required", "pending", "signed", "bypassed" ] }, "ndaSignedAt": { "type": "string", "format": "date-time" }, "signedNdaReleaseId": { "oneOf": [ { "type": "string" } ] }, "signedNdaContentHash": { "oneOf": [ { "type": "string" } ] }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationToken": { "type": "string" }, "verificationTokenExpiresAt": { "type": "string", "format": "date-time" }, "emailSubscribed": { "type": "boolean" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "requesterName", "requesterEmail", "status", "ndaRequired", "ndaStatus", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/access-requests/{accessRequestId}/resend": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_audience_access_requests_accessrequestid_resend", "summary": "Resend the magic-link email", "tags": [ "Trust Centers" ], "description": "Rotates the access token on an approved access request and sends the visitor a fresh access email. Cascades revocation of any live portal session.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "accessRequestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "requesterName": { "type": "string", "maxLength": 1024 }, "requesterEmail": { "type": "string", "format": "email" }, "requesterCompany": { "type": "string", "maxLength": 1024 }, "reason": { "type": "string", "maxLength": 5000 }, "status": { "type": "string", "enum": [ "awaiting_verification", "pending", "approved", "denied" ] }, "approvalType": { "type": "string", "enum": [ "manual", "auto_domain", "auto_email", "invitation", "returning" ] }, "processedBy": { "type": "string", "maxLength": 1024 }, "audienceEmailId": { "type": "string", "format": "uuid" }, "audienceDomainId": { "type": "string", "format": "uuid" }, "reviewedBy": { "type": "string", "maxLength": 1024 }, "reviewedAt": { "type": "string", "format": "date-time" }, "extendedAt": { "type": "string", "format": "date-time" }, "accessToken": { "type": "string" }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "tokenUsedAt": { "type": "string", "format": "date-time" }, "ndaRequired": { "type": "boolean" }, "ndaDocumentId": { "type": "string", "format": "uuid" }, "ndaStatus": { "type": "string", "enum": [ "not_required", "pending", "signed", "bypassed" ] }, "ndaSignedAt": { "type": "string", "format": "date-time" }, "signedNdaReleaseId": { "oneOf": [ { "type": "string" } ] }, "signedNdaContentHash": { "oneOf": [ { "type": "string" } ] }, "verifiedAt": { "type": "string", "format": "date-time" }, "verificationToken": { "type": "string" }, "verificationTokenExpiresAt": { "type": "string", "format": "date-time" }, "emailSubscribed": { "type": "boolean" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "requesterName", "requesterEmail", "status", "ndaRequired", "ndaStatus", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/domains": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_audience_domains", "summary": "List audience domains", "tags": [ "Trust Audience" ], "description": "Lists allowed/derived domains for a trust project audience.", "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "autoApprove", "required": false }, { "schema": { "type": "string", "enum": [ "approved", "blocked" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "countOnly", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "domain": { "type": "string", "maxLength": 256, "pattern": "^[a-z0-9.-]+\\.[a-z]{2,}$/i" }, "companyName": { "type": "string", "maxLength": 256 }, "source": { "type": "string", "enum": [ "admin", "derived" ] }, "status": { "type": "string", "default": "approved", "enum": [ "approved", "blocked" ] }, "reason": { "oneOf": [ { "type": "string" } ] }, "autoApprove": { "type": "boolean" }, "emailCount": { "type": "integer", "minimum": 0 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "domain", "source", "autoApprove", "emailCount", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_audience_domains", "summary": "Add an audience domain", "tags": [ "Trust Audience" ], "description": "Adds a domain to the trust project audience. Admin-added domains default to autoApprove=true.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "maxLength": 256, "pattern": "^[a-z0-9.-]+\\.[a-z]{2,}$/i" }, "companyName": { "type": "string", "maxLength": 256 }, "autoApprove": { "type": "boolean" }, "status": { "type": "string", "enum": [ "approved", "blocked" ] }, "reason": { "type": "string", "maxLength": 512 } }, "required": [ "domain" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "domain": { "type": "string", "maxLength": 256, "pattern": "^[a-z0-9.-]+\\.[a-z]{2,}$/i" }, "companyName": { "type": "string", "maxLength": 256 }, "source": { "type": "string", "enum": [ "admin", "derived" ] }, "status": { "type": "string", "default": "approved", "enum": [ "approved", "blocked" ] }, "reason": { "oneOf": [ { "type": "string" } ] }, "autoApprove": { "type": "boolean" }, "emailCount": { "type": "integer", "minimum": 0 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "domain", "source", "autoApprove", "emailCount", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/domains/{audienceDomainId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_audience_domains_audiencedomainid", "summary": "Update an audience domain", "tags": [ "Trust Audience" ], "description": "Patches an audience domain (e.g., toggle autoApprove or update companyName).", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "audienceDomainId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "domain": { "type": "string", "maxLength": 256, "pattern": "^[a-z0-9.-]+\\.[a-z]{2,}$/i" }, "companyName": { "type": "string", "maxLength": 256 }, "source": { "type": "string", "enum": [ "admin", "derived" ] }, "status": { "type": "string", "default": "approved", "enum": [ "approved", "blocked" ] }, "reason": { "oneOf": [ { "type": "string" } ] }, "autoApprove": { "type": "boolean" }, "emailCount": { "type": "integer", "minimum": 0 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "domain", "source", "autoApprove", "emailCount", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_audience_domains_audiencedomainid", "summary": "Remove an audience domain", "tags": [ "Trust Audience" ], "description": "Removes a domain from the audience and cascade-deletes all linked emails. Returns the count of removed emails.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "audienceDomainId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "removedEmails": { "type": "integer", "minimum": 0 } }, "required": [ "success", "removedEmails" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/emails": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_audience_emails", "summary": "List audience emails", "tags": [ "Trust Audience" ], "description": "Lists individual audience emails for a trust project.", "parameters": [ { "schema": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "audienceDomainId", "required": false }, { "schema": { "type": "string", "format": "email" }, "in": "query", "name": "email", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "countOnly", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0 }, "count": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 256 }, "audienceDomainId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "ndaBypass": { "type": "boolean" }, "source": { "type": "string", "enum": [ "invitation", "request", "auto_domain", "auto_email", "manual", "returning" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "email", "status", "ndaBypass", "source", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_audience_emails", "summary": "Add an audience email", "tags": [ "Trust Audience" ], "description": "Adds a single individual email to the trust project audience.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "ndaBypass": { "type": "boolean" } }, "required": [ "email" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 256 }, "audienceDomainId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "ndaBypass": { "type": "boolean" }, "source": { "type": "string", "enum": [ "invitation", "request", "auto_domain", "auto_email", "manual", "returning" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "email", "status", "ndaBypass", "source", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/emails/{audienceEmailId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_audience_emails_audienceemailid", "summary": "Update an audience email", "tags": [ "Trust Audience" ], "description": "Patches an audience email (status, expiry, NDA bypass, name).", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "op", "path" ], "additionalProperties": false } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "audienceEmailId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 256 }, "audienceDomainId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "ndaBypass": { "type": "boolean" }, "source": { "type": "string", "enum": [ "invitation", "request", "auto_domain", "auto_email", "manual", "returning" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "email", "status", "ndaBypass", "source", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_audience_emails_audienceemailid", "summary": "Remove an audience email", "tags": [ "Trust Audience" ], "description": "Removes an individual email from the trust project audience.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "audienceEmailId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/audience/invitations": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_audience_invitations", "summary": "Bulk invite emails", "tags": [ "Trust Audience" ], "description": "Creates audience email entries for a list of emails. Skips any that already exist. Auto-derives audience domains.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "emails": { "type": "array", "minItems": 1, "items": { "type": "string", "format": "email" } }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "ndaBypass": { "type": "boolean" } }, "required": [ "emails" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "integer", "minimum": 0 }, "skipped": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "trustCenterId": { "type": "string", "format": "uuid" }, "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 256 }, "audienceDomainId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "expired", "revoked" ] }, "accessExpiresAt": { "type": "string", "format": "date-time" }, "ndaBypass": { "type": "boolean" }, "source": { "type": "string", "enum": [ "invitation", "request", "auto_domain", "auto_email", "manual", "returning" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "email", "status", "ndaBypass", "source", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "created", "skipped", "items" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/analytics/summaries": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_analytics_summaries", "summary": "List trust center analytics rollups", "tags": [ "Trust Centers" ], "description": "Returns pre-computed hourly/daily/weekly/monthly summary rows for a trust project. Populated by the trust-center-aggregator task.", "parameters": [ { "schema": { "type": "string", "enum": [ "hour", "day", "week", "month" ] }, "in": "query", "name": "granularity", "required": true }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "from", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "to", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "includePartialBucket", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "trustCenterId": { "type": "string" }, "period": { "type": "integer" }, "granularity": { "type": "string", "enum": [ "hour", "day", "week", "month" ] }, "metrics": { "type": "object", "properties": {}, "additionalProperties": true }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "trustCenterId", "period", "granularity", "metrics", "dateCreated", "dateUpdated" ], "additionalProperties": true } }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/analytics/announcements-overview": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_analytics_announcements_overview", "summary": "Get Announcements dashboard overview", "tags": [ "Trust Centers" ], "description": "Aggregated announcement*Count totals + top-N subscribers ranked by engagement score for the Trust dashboard Announcements section.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "topN", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "totals": { "type": "object", "properties": { "announcementSentCount": { "type": "integer", "minimum": 0 }, "announcementBouncedCount": { "type": "integer", "minimum": 0 }, "announcementComplainedCount": { "type": "integer", "minimum": 0 }, "announcementOpenedCount": { "type": "integer", "minimum": 0 }, "announcementClickedCount": { "type": "integer", "minimum": 0 }, "announcementRejectedCount": { "type": "integer", "minimum": 0 }, "announcementUnsubscribedCount": { "type": "integer", "minimum": 0 } }, "required": [ "announcementSentCount", "announcementBouncedCount", "announcementComplainedCount", "announcementOpenedCount", "announcementClickedCount", "announcementRejectedCount", "announcementUnsubscribedCount" ], "additionalProperties": false }, "topSubscribers": { "type": "array", "items": { "type": "object", "properties": { "subscriberId": { "type": "string" }, "email": { "type": "string" }, "score": { "type": "integer", "minimum": 0, "maximum": 100 }, "tier": { "type": "string", "enum": [ "hot", "warm", "cold" ] }, "sentCount": { "type": "integer", "minimum": 0 }, "openedCount": { "type": "integer", "minimum": 0 }, "clickedCount": { "type": "integer", "minimum": 0 }, "lastDeliveryAt": { "oneOf": [ { "type": "string" } ] }, "lastOpenAt": { "oneOf": [ { "type": "string" } ] }, "lastClickAt": { "oneOf": [ { "type": "string" } ] } }, "required": [ "subscriberId", "email", "score", "tier", "sentCount", "openedCount", "clickedCount", "lastDeliveryAt", "lastOpenAt", "lastClickAt" ], "additionalProperties": false } } }, "required": [ "totals", "topSubscribers" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/knowledge-base": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_knowledge_base", "summary": "List per-document indexing status for the RAG knowledge base", "tags": [ "Trust Centers" ], "description": "Returns the ragKnowledgeBaseEntries rows for this trust center so the admin UI can render a status badge per document (pending / indexing / indexed / failed). Poll while any row is pending or indexing; rows transition to indexed or failed when the worker finishes.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string" }, "entries": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "indexing", "indexed", "failed" ] }, "chunkCount": { "type": "integer", "minimum": 0 }, "documentVersion": { "type": "integer" }, "indexedAt": { "oneOf": [ { "type": "string" } ] }, "failureReason": { "oneOf": [ { "type": "string" } ] } }, "required": [ "documentId", "status", "chunkCount", "documentVersion", "indexedAt", "failureReason" ], "additionalProperties": false } } }, "required": [ "trustCenterId", "entries" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "put": { "operationId": "put_trust_v1_organizations_organizationid_projects_projectid_knowledge_base", "summary": "Replace the RAG knowledge base document set", "tags": [ "Trust Centers" ], "description": "Replaces the trust center’s ragKnowledgeBaseDocumentIds with the provided set in one atomic write. New ids are enqueued for indexing; removed ids fall out of retrieval scope immediately (vector cleanup is deferred).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documents": { "type": "array", "items": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" } }, "required": [ "documentId" ], "additionalProperties": false } } }, "required": [ "documents" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string" }, "included": { "type": "array", "items": { "type": "string" } }, "added": { "type": "array", "items": { "type": "string" } }, "removed": { "type": "array", "items": { "type": "string" } }, "enqueuedCount": { "type": "integer", "minimum": 0 } }, "required": [ "trustCenterId", "included", "added", "removed", "enqueuedCount" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/knowledge-base/reindex": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_knowledge_base_reindex", "summary": "Reindex the RAG knowledge base", "tags": [ "Trust Centers" ], "description": "Manually reindex one document (body.documentId set) or every document in the trust center's RAG knowledge base (body.documentId omitted). Worker enforces stale-version protection so racing this with doc edits is safe.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentId": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string" }, "enqueuedCount": { "type": "integer", "minimum": 0 } }, "required": [ "trustCenterId", "enqueuedCount" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/upload": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_questionnaires_upload", "summary": "Upload a questionnaire (multipart) and parse its rows", "tags": [ "Trust Centers" ], "description": "Multipart file upload for a vendor questionnaire (CSV/XLSX/XLS/PDF/DOCX). CSV/XLSX/XLS parse synchronously and the questionnaire returns in `draft` state. PDF/DOCX persist the file, return the questionnaire in `parsing` state, and enqueue the worker's parse-questionnaire job — the admin UI polls until rows arrive (or status flips to `rejected` with a `failureReason`). Optional querystring `kind` switches the agent prompt to RFP voice; optional `customPrompt` is appended to the user message at generation time (capped at 1000 chars, sanitized server-side).", "parameters": [ { "schema": { "type": "string", "enum": [ "questionnaire", "rfp" ] }, "in": "query", "name": "kind", "required": false }, { "schema": { "type": "string", "maxLength": 1000 }, "in": "query", "name": "customPrompt", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_questionnaires", "summary": "List questionnaires for a trust center", "tags": [ "Trust Centers" ], "description": "Returns every questionnaire that belongs to the trust center, most recently updated first.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } }, "total": { "type": "integer" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/{questionnaireId}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid", "summary": "Get a single questionnaire by id", "tags": [ "Trust Centers" ], "description": "Returns one questionnaire, including all of its rows.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid", "summary": "Edit questionnaire metadata (name, kind, customPrompt, modelId)", "tags": [ "Trust Centers" ], "description": "Updates a questionnaire's name, kind, custom prompt, or answer-generation model.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "kind": { "type": "string", "enum": [ "questionnaire", "rfp" ] }, "customPrompt": { "oneOf": [ { "type": "string" } ] }, "modelId": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid", "summary": "Delete a questionnaire and cascade to its uploaded source document", "tags": [ "Trust Centers" ], "description": "Deletes a questionnaire and its uploaded source document.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/{questionnaireId}/rows": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid_rows", "summary": "Add, edit, or delete questionnaire rows (pre-generation only)", "tags": [ "Trust Centers" ], "description": "Adds, edits, or deletes questionnaire rows before answers have been generated for them.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ops": { "type": "array", "minItems": 1, "items": { "anyOf": [ { "type": "object", "properties": { "op": { "enum": [ "add" ] }, "question": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "op", "question" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "enum": [ "update" ] }, "rowId": { "type": "string" }, "question": { "type": "string", "minLength": 1, "maxLength": 4000 } }, "required": [ "op", "rowId", "question" ], "additionalProperties": false }, { "type": "object", "properties": { "op": { "enum": [ "delete" ] }, "rowId": { "type": "string" } }, "required": [ "op", "rowId" ], "additionalProperties": false } ] } } }, "required": [ "ops" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/{questionnaireId}/generate": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid_generate", "summary": "Kick off AI generation for every pending questionnaire row", "tags": [ "Trust Centers" ], "description": "Flips the questionnaire to `answering` and enqueues an SQS job for apps/ai-agent-worker. The worker iterates pending rows, runs each through the KnowledgeBaseAgent, debits Action + Data Credits, and flips the questionnaire to `review` (or `rejected` on failure).", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/{questionnaireId}/rows/{rowId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid_rows_rowid", "summary": "Edit or regenerate a single questionnaire row draft answer", "tags": [ "Trust Centers" ], "description": "Directly overwrites a row's draft answer, or asks the AI agent to regenerate it from the trust center's documents.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "edit", "regenerate" ] }, "generatedAnswer": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "action" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "rowId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/{questionnaireId}/rows/approval": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid_rows_approval", "summary": "Approve or reject many questionnaire rows in one batch", "tags": [ "Trust Centers" ], "description": "Approves or rejects a batch of questionnaire rows in one request.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ops": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "approve", "reject" ] }, "rowId": { "type": "string" }, "approvedAnswer": { "type": "string" }, "rejectionReason": { "type": "string", "maxLength": 2000 } }, "required": [ "op", "rowId" ], "additionalProperties": false } } }, "required": [ "ops" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/questionnaires/{questionnaireId}/export": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_questionnaires_questionnaireid_export", "summary": "Build the annotated XLSX export and return a download URL", "tags": [ "Trust Centers" ], "description": "Generates an XLSX export of the approved answers and returns a download link.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "questionnaireId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "questionnaire": { "type": "object", "properties": {}, "additionalProperties": true }, "downloadUrl": { "type": "string", "format": "uri" } }, "required": [ "questionnaire", "downloadUrl" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/custom-domain": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_custom_domain", "summary": "Claim a custom domain for a trust center", "tags": [ "Trust Centers" ], "description": "Allocates a SAN slot on a managed multi-SAN ACM cert and returns the DNS-01 CNAMEs the customer must add to their zone. Plan-gated to orgs entitled to `customDomainsEnabled`. The trust center's `customDomainStatus` flips to `'cert_pending'` until the customer completes DNS validation and calls /verify.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "host": { "type": "string", "maxLength": 256, "pattern": "^[a-z0-9.-]+\\.[a-z]{2,}$/i" } }, "required": [ "host" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": [ "cert_pending" ] }, "cnames": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "value": { "type": "string" }, "type": { "type": "string" } }, "required": [ "name", "value" ], "additionalProperties": false } } }, "required": [ "status", "cnames" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_custom_domain", "summary": "Remove a custom domain from a trust center", "tags": [ "Trust Centers" ], "description": "Sync part: free the unique-index slot and remove the host from CloudFront's Aliases list. Async cert teardown is handled by the reconcile() pass on a 15-min schedule.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "enum": [ true ] } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/custom-domain/verify": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_custom_domain_verify", "summary": "Verify a pending custom domain", "tags": [ "Trust Centers" ], "description": "Polls the cert/distribution state. Idempotent — admin UI calls this every few seconds while the customer waits for DNS-01 validation to complete. Transitions cert_pending → distribution_pending → active.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "pending", "cert_pending", "distribution_pending", "active", "cleanup_pending", "failed" ] }, "customDomain": { "type": "string" }, "failureReason": { "type": "string" } }, "required": [ "status" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/memory/{kind}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_memory_kind", "summary": "Read the agent memory body for a (trust center, kind) pair", "tags": [ "Trust Centers" ], "description": "Returns the admin-curated memory body for the requested agent kind (chat / questionnaire / rfp), along with version + history. Empty stub on first read (no row yet); save via PATCH to create.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "in": "path", "name": "kind", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "body": { "type": "string" }, "version": { "type": "integer", "minimum": 0 }, "lastEditedBy": { "type": "string" }, "lastEditedAt": { "type": "string", "format": "date-time" }, "history": { "type": "array", "items": { "type": "object", "properties": { "body": { "type": "string" }, "version": { "type": "integer", "minimum": 0 }, "editedBy": { "type": "string" }, "editedAt": { "type": "string", "format": "date-time" } }, "required": [ "body", "version", "editedBy", "editedAt" ], "additionalProperties": false } } }, "required": [ "trustCenterId", "kind", "body", "version", "lastEditedBy", "lastEditedAt", "history" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_memory_kind", "summary": "Update the agent memory body for a (trust center, kind) pair", "tags": [ "Trust Centers" ], "description": "Discriminated body: `{ body }` replaces the memory with new Markdown (re-runs scanForInjection, rejects 400 on unsafe content); `{ targetVersion }` reverts to a prior version from history. Both paths bump version + append the prior body to history (cap 10).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "body": { "type": "string", "maxLength": 4096 }, "targetVersion": { "type": "integer", "minimum": 0 } }, "additionalProperties": false, "if": { "propertyNames": { "enum": [ "body", "targetVersion" ] }, "minProperties": 2 }, "then": false, "else": { "oneOf": [ { "required": [ "body" ] }, { "required": [ "targetVersion" ] } ] } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "in": "path", "name": "kind", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "body": { "type": "string" }, "version": { "type": "integer", "minimum": 0 }, "lastEditedBy": { "type": "string" }, "lastEditedAt": { "type": "string", "format": "date-time" } }, "required": [ "trustCenterId", "kind", "body", "version", "lastEditedBy", "lastEditedAt" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/memory/{kind}/suggestions": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_memory_kind_suggestions", "summary": "List memory suggestions for a (trust center, kind) pair", "tags": [ "Trust Centers" ], "description": "Returns the AI agent memory suggestions for a trust center and memory kind, optionally filtered by status.", "parameters": [ { "schema": { "type": "string", "enum": [ "pending", "applied", "dismissed" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "in": "path", "name": "kind", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "status": { "type": "string", "enum": [ "pending", "applied", "dismissed" ] }, "suggestions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "suggestionMarkdown": { "type": "string" }, "rationale": { "type": "string" }, "sourceRows": { "type": "array", "items": { "type": "object", "properties": { "kind": { "type": "string", "enum": [ "chat_transcript", "reviewed_answer" ] }, "id": { "type": "string" } }, "required": [ "kind", "id" ], "additionalProperties": false } }, "status": { "type": "string", "enum": [ "pending", "applied", "dismissed" ] }, "modelIdUsed": { "type": "string" }, "reviewedBy": { "type": "string" }, "reviewedAt": { "type": "string", "format": "date-time" }, "dateCreated": { "type": "string", "format": "date-time" } }, "required": [ "id", "suggestionMarkdown", "rationale", "sourceRows", "status", "modelIdUsed", "dateCreated" ], "additionalProperties": false } } }, "required": [ "trustCenterId", "kind", "status", "suggestions" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/memory/suggestions/{suggestionId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_memory_suggestions_suggestionid", "summary": "Apply or dismiss a pending memory suggestion", "tags": [ "Trust Centers" ], "description": "Body `{ status: 'applied' }` installs the suggestion body as the current memory for the matching (trust center, kind), bumps version + appends prior body to history, and marks the suggestion applied. Body `{ status: 'dismissed' }` only flips the suggestion's status. Re-runs scanForInjection on apply — rejects with 400 + auto-dismisses when content is unsafe.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "applied", "dismissed" ] } }, "required": [ "status" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "suggestionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "status": { "enum": [ "applied" ] }, "trustCenterId": { "type": "string", "format": "uuid" }, "kind": { "type": "string", "enum": [ "chat", "questionnaire", "rfp" ] }, "body": { "type": "string" }, "version": { "type": "integer", "minimum": 0 }, "appliedSuggestionId": { "type": "string" } }, "required": [ "status", "trustCenterId", "kind", "body", "version", "appliedSuggestionId" ], "additionalProperties": false }, { "type": "object", "properties": { "status": { "enum": [ "dismissed" ] }, "suggestionId": { "type": "string" } }, "required": [ "status", "suggestionId" ], "additionalProperties": false } ] } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/self-learning/overview": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_self_learning_overview", "summary": "Self-learning overview for the Trust dashboard", "tags": [ "Trust Centers" ], "description": "Returns approved-answer corpus size (total + month-over-month), memory-suggestion counts by status (pending/applied/dismissed), and the most recent memory-edit timestamp + source. Cheap counts; safe to call on every dashboard refresh.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "approvedAnswers": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "addedThisMonth": { "type": "integer", "minimum": 0 } }, "required": [ "total", "addedThisMonth" ], "additionalProperties": false }, "memorySuggestions": { "type": "object", "properties": { "pending": { "type": "integer", "minimum": 0 }, "applied": { "type": "integer", "minimum": 0 }, "dismissed": { "type": "integer", "minimum": 0 } }, "required": [ "pending", "applied", "dismissed" ], "additionalProperties": false }, "lastMemoryUpdate": { "oneOf": [ { "type": "object" } ] } }, "required": [ "approvedAnswers", "memorySuggestions", "lastMemoryUpdate" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/knowledge-base/approved-answers": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_knowledge_base_approved_answers", "summary": "List approved answers in the Knowledge Base corpus", "tags": [ "Trust Centers" ], "description": "Returns paginated approved-answer rows for the corpus tab. Filterable by substring search and by view (active corpus vs archived audit). Page size bounded to [1, 500] — the admin tab fetches the whole corpus client-side so DataTable can sort/filter in-place without a round-trip per keystroke.", "parameters": [ { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "pageSize", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string", "enum": [ "approved", "archived" ] }, "in": "query", "name": "view", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "question": { "type": "string" }, "approvedAnswer": { "type": "string" }, "questionnaireId": { "type": "string" }, "rowId": { "type": "string" }, "reviewOutcome": { "type": "string", "enum": [ "approved_unchanged", "approved_edited", "rejected", "archived" ] }, "reviewedBy": { "oneOf": [ { "type": "string" } ] }, "reviewedAt": { "type": "string", "format": "date-time" }, "expiresAt": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "question", "approvedAnswer", "questionnaireId", "rowId", "reviewOutcome", "reviewedBy", "reviewedAt", "expiresAt" ], "additionalProperties": false } }, "total": { "type": "integer", "minimum": 0 }, "page": { "type": "integer", "minimum": 1 }, "pageSize": { "type": "integer", "minimum": 1 } }, "required": [ "items", "total", "page", "pageSize" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_knowledge_base_approved_answers", "summary": "Bulk-mutate approved answers in the Knowledge Base corpus", "tags": [ "Trust Centers" ], "description": "Apply 1..N ops to approved-answer rows. Today supports `archive` (vector delete + flip reviewOutcome to `archived`; reopening the source questionnaire doesn't re-index). Triggers memory-suggestion re-synthesis with trigger=corpus_removal so the meta-LLM can update memory in light of what was removed.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "ops": { "type": "array", "minItems": 1, "maxItems": 500, "items": { "type": "object", "properties": { "op": { "enum": [ "archive" ] }, "id": { "type": "string" } }, "required": [ "op", "id" ], "additionalProperties": false } } }, "required": [ "ops" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "archived": { "type": "integer", "minimum": 0 }, "skipped": { "type": "integer", "minimum": 0 } }, "required": [ "archived", "skipped" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/announcements": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_announcements", "summary": "Create a draft trust-center announcement", "tags": [ "Trust Centers" ], "description": "Creates a new `draft` announcement. Use the publish route to flip status and fan out the email broadcast. `bodyLexical` is the Lexical EditorState JSON authored by the composer; the controller renders sanitized HTML once and caches it on the doc.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 512 }, "bodyLexical": { "type": "string", "minLength": 2, "maxLength": 500000 }, "category": { "type": "string", "enum": [ "general", "compliance", "vulnerability", "incident" ] } }, "required": [ "title", "bodyLexical" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_announcements", "summary": "List trust-center announcements (admin view, all statuses)", "tags": [ "Trust Centers" ], "description": "Returns a paginated list of trust center announcements for the admin view, including drafts, optionally filtered by status or category.", "parameters": [ { "schema": { "type": "string", "enum": [ "draft", "published" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "general", "compliance", "vulnerability", "incident" ] }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/announcements/{announcementId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_projects_projectid_announcements_announcementid", "summary": "Edit a trust-center announcement (draft or published)", "tags": [ "Trust Centers" ], "description": "Updates title / body / category. Status transitions live on the dedicated publish route — generic patch will not flip draft → published, otherwise the email fanout would be skipped.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 512 }, "bodyLexical": { "type": "string", "minLength": 2, "maxLength": 500000 }, "category": { "type": "string", "enum": [ "general", "compliance", "vulnerability", "incident" ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "announcementId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_announcements_announcementid", "summary": "Hard-delete a trust-center announcement", "tags": [ "Trust Centers" ], "description": "Removes the announcement from the public feed and the admin list. Already-sent emails are not recalled (we cannot un-send).", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "announcementId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": [ "deleted" ] } }, "required": [ "status" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_announcements_announcementid", "summary": "Get a single trust-center announcement (admin view)", "tags": [ "Trust Centers" ], "description": "Returns a single trust center announcement by ID, including unpublished drafts, for the admin view.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "announcementId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/announcements/{announcementId}/publish": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_announcements_announcementid_publish", "summary": "Publish a trust-center announcement + broadcast to subscribers", "tags": [ "Trust Centers" ], "description": "Flips status `draft → published`, stamps `publishedAt`, and starts the background fanout. Returns immediately with the subscriber count + initial `publishStatus`. Subscribers receive the announcement asynchronously; admin polls the announcement detail to watch `deliveryStats.publishStatus` move to `sent` or `failed`. On `failed`, admin can hit publish again to retry only the un-enqueued subscribers (per-subscriber dedup on `lastBroadcastEnqueuedFor`).", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "announcementId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "announcement": { "type": "object", "properties": {}, "additionalProperties": true }, "subscriberCount": { "type": "integer", "minimum": 0 }, "publishStatus": { "type": "string", "enum": [ "pending", "processing", "sent", "failed" ] } }, "required": [ "subscriberCount", "publishStatus" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/announcements/{announcementId}/delivery-failures": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_announcements_announcementid_delivery_failures", "summary": "List delivery failures (bounces / complaints) for a published announcement", "tags": [ "Trust Centers" ], "description": "Returns a paginated list of email delivery failures, such as bounces or complaints, for a trust center announcement.", "parameters": [ { "schema": { "type": "string", "enum": [ "bounce", "complaint" ] }, "in": "query", "name": "failureType", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "announcementId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/subscribers": { "get": { "operationId": "get_trust_v1_organizations_organizationid_projects_projectid_subscribers", "summary": "List trust-center email subscribers (admin)", "tags": [ "Trust Centers" ], "description": "Returns a paginated list of email subscribers for a trust center, optionally filtered by status or source.", "parameters": [ { "schema": { "type": "string", "enum": [ "awaiting_verification", "confirmed", "unsubscribed" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "subscribe_form", "access_request" ] }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 500 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "countOnly", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": true } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/subscribers/{subscriberId}": { "delete": { "operationId": "delete_trust_v1_organizations_organizationid_projects_projectid_subscribers_subscriberid", "summary": "Hard-delete a trust-center subscriber (admin)", "tags": [ "Trust Centers" ], "description": "Removes the subscriber Mongo row entirely. Distinct from the visitor-driven unsubscribe flow, which flips status → 'unsubscribed' and preserves the row for audit / re-opt-in.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "subscriberId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "enum": [ "deleted" ] } }, "required": [ "status" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/subscribers/export": { "post": { "operationId": "post_trust_v1_organizations_organizationid_projects_projectid_subscribers_export", "summary": "Export trust-center subscribers as CSV (admin)", "tags": [ "Trust Centers" ], "description": "Returns trust center subscribers as CSV text in the response body, optionally filtered by confirmation status.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "confirmed", "all" ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string" }, "rowCount": { "type": "integer", "minimum": 0 } }, "required": [ "csv", "rowCount" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/adopt-update": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_adopt_update", "summary": "Adopt control template updates", "tags": [ "Controls" ], "description": "Updates the given controls to match the latest version of their source templates.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "controlIds": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "controlIds" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "updated": { "type": "number" } }, "required": [ "updated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/evaluate": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_evaluate", "summary": "Mark a control as evaluated", "tags": [ "Controls" ], "description": "Records a control evaluation outcome along with its supporting evidence.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evidence": { "type": "object", "properties": { "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "collectedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "validUntil": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "notes": { "type": "string" } }, "required": [ "evidenceType" ] } }, "required": [ "evaluationStatus", "evidence" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "control": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "domain": { "type": "string" }, "ownerUserId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "ownerEmail": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "implemented" ] }, "evaluationStatus": { "type": "string", "enum": [ "pass", "fail", "unknown", "needs_review", "not_applicable" ] }, "evaluationSource": { "type": "string", "enum": [ "tests", "manual", "untested" ] }, "evaluationFrequency": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "lastEvaluatedAt": { "type": "string" }, "lastEvaluatedByUserId": { "type": "string" }, "nextEvaluationDueAt": { "type": "string" }, "notes": { "type": "string" }, "archivedAt": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "templateRetired": { "type": "boolean" }, "implementationGuidance": { "type": "string" }, "testProcedure": { "type": "string" }, "suggestedEvidenceTypes": { "type": "array", "items": { "type": "string" } }, "suggestedOwnerRole": { "type": "string" } }, "required": [ "id", "organizationId", "key", "name", "status", "evaluationStatus" ], "additionalProperties": {} }, "evidence": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "tags": { "type": "array", "items": { "type": "string" } }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "title": { "type": "string" }, "collectedAt": { "type": "string" }, "validFrom": { "type": "string" }, "validUntil": { "type": "string" }, "addedByUserId": { "type": "string" }, "notes": { "type": "string" }, "fulfillsTaskId": { "type": "string" }, "evidenceReleaseId": { "type": "string" }, "evidenceDocumentVersion": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "evidenceType", "collectedAt", "addedByUserId" ], "additionalProperties": {} } }, "required": [ "control", "evidence" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/tests": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_tests", "summary": "Define a control test", "tags": [ "Controls" ], "description": "Creates a new test definition for a control.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "required": { "type": "boolean" }, "cadence": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "expectedEvidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "monitorKey": { "type": "string" } }, "required": [ "name" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "cadence": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "expectedEvidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "monitorKey": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "disabled" ] }, "lastRunResult": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "lastRunAt": { "type": "string" }, "lastRunDetail": { "type": "string" }, "lastRunProvider": { "type": "string" }, "lastRunFailingGroups": { "type": "array", "items": { "type": "object", "properties": { "checkKey": { "type": "string" }, "count": { "type": "number" }, "sample": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "accountId": { "type": "string" }, "region": { "type": "string" } }, "required": [ "resourceType", "resourceId" ], "additionalProperties": false } } }, "required": [ "count", "sample" ], "additionalProperties": false } }, "lastRunFailingCount": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "name", "required", "status" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_tests", "summary": "List control tests", "tags": [ "Controls" ], "description": "Returns the tests defined for a control.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "cadence": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "expectedEvidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "monitorKey": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "disabled" ] }, "lastRunResult": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "lastRunAt": { "type": "string" }, "lastRunDetail": { "type": "string" }, "lastRunProvider": { "type": "string" }, "lastRunFailingGroups": { "type": "array", "items": { "type": "object", "properties": { "checkKey": { "type": "string" }, "count": { "type": "number" }, "sample": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "accountId": { "type": "string" }, "region": { "type": "string" } }, "required": [ "resourceType", "resourceId" ], "additionalProperties": false } } }, "required": [ "count", "sample" ], "additionalProperties": false } }, "lastRunFailingCount": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "name", "required", "status" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/tests/{controlTestId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_controls_controlid_tests_controltestid", "summary": "Update a control test", "tags": [ "Controls" ], "description": "Updates fields on an existing control test definition.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "required": { "type": "boolean" }, "cadence": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "expectedEvidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "monitorKey": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "disabled" ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlTestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "cadence": { "type": "string", "enum": [ "continuous", "monthly", "quarterly", "semi_annual", "annual" ] }, "expectedEvidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "monitorKey": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "disabled" ] }, "lastRunResult": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "lastRunAt": { "type": "string" }, "lastRunDetail": { "type": "string" }, "lastRunProvider": { "type": "string" }, "lastRunFailingGroups": { "type": "array", "items": { "type": "object", "properties": { "checkKey": { "type": "string" }, "count": { "type": "number" }, "sample": { "type": "array", "items": { "type": "object", "properties": { "resourceType": { "type": "string" }, "resourceId": { "type": "string" }, "accountId": { "type": "string" }, "region": { "type": "string" } }, "required": [ "resourceType", "resourceId" ], "additionalProperties": false } } }, "required": [ "count", "sample" ], "additionalProperties": false } }, "lastRunFailingCount": { "type": "number" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "name", "required", "status" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/tests/{controlTestId}/run": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_tests_controltestid_run", "summary": "Run a control test", "tags": [ "Controls" ], "description": "Records the result of running a control test, optionally with supporting evidence.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "result": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "detail": { "type": "string" }, "output": {}, "ranAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "evidence": { "type": "object", "properties": { "evidenceType": { "type": "string", "enum": [ "document", "action_run", "questionnaire_response", "approval", "data_system", "vendor", "policy", "trust_signal_source", "screenshot", "config_export", "manual_attestation", "access_review", "training_record", "pen_test_report", "background_check" ] }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string", "format": "uri" }, "title": { "type": "string" }, "notes": { "type": "string" } }, "required": [ "evidenceType" ] } }, "required": [ "result" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlTestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "run": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "controlTestId": { "type": "string" }, "result": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "ranAt": { "type": "string" }, "source": { "type": "string", "enum": [ "manual", "automated" ] }, "detail": { "type": "string" }, "output": {}, "controlEvidenceId": { "type": "string" }, "sweepId": { "type": "string" }, "actionRunId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "controlTestId", "result", "ranAt", "source" ], "additionalProperties": false }, "controlEvidenceId": { "type": "string" } }, "required": [ "run" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/tests/{controlTestId}/runs": { "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_tests_controltestid_runs", "summary": "List control test runs", "tags": [ "Controls" ], "description": "Returns the recorded runs for a control test.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "actionRunId", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlTestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "controlTestId": { "type": "string" }, "result": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "ranAt": { "type": "string" }, "source": { "type": "string", "enum": [ "manual", "automated" ] }, "detail": { "type": "string" }, "output": {}, "controlEvidenceId": { "type": "string" }, "sweepId": { "type": "string" }, "actionRunId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "controlTestId", "result", "ranAt", "source" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/control-test-runs/by-action-run/{actionRunId}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_control_test_runs_by_action_run_actionrunid", "tags": [ "Controls" ], "description": "Control test runs recorded by one action run.", "parameters": [ { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "actionRunId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "controlTestId": { "type": "string" }, "result": { "type": "string", "enum": [ "pass", "fail", "error", "inconclusive" ] }, "ranAt": { "type": "string" }, "source": { "type": "string", "enum": [ "manual", "automated" ] }, "detail": { "type": "string" }, "output": {}, "controlEvidenceId": { "type": "string" }, "sweepId": { "type": "string" }, "actionRunId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "controlTestId", "result", "ranAt", "source" ], "additionalProperties": false } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/control-test-runs/check-posture": { "get": { "operationId": "get_trust_v1_organizations_organizationid_control_test_runs_check_posture", "summary": "Get check posture", "tags": [ "Controls" ], "description": "How many monitored checks are passing, failing by severity, or could not be checked, from each check's latest result.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "passing": { "type": "number" }, "failing": { "type": "object", "properties": { "critical": { "type": "number" }, "high": { "type": "number" }, "medium": { "type": "number" }, "low": { "type": "number" } }, "required": [ "critical", "high", "medium", "low" ], "additionalProperties": false }, "notChecked": { "type": "number" }, "providers": { "type": "array", "items": { "type": "object", "properties": { "passing": { "type": "number" }, "failing": { "type": "object", "properties": { "critical": { "type": "number" }, "high": { "type": "number" }, "medium": { "type": "number" }, "low": { "type": "number" } }, "required": [ "critical", "high", "medium", "low" ], "additionalProperties": false }, "notChecked": { "type": "number" }, "provider": { "type": "string" } }, "required": [ "passing", "failing", "notChecked", "provider" ], "additionalProperties": false } }, "lastCheckedAt": { "type": "string" } }, "required": [ "passing", "failing", "notChecked", "providers" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/exceptions": { "post": { "operationId": "post_trust_v1_organizations_organizationid_controls_controlid_exceptions", "summary": "Create a control exception", "tags": [ "Controls" ], "description": "Creates an exception for a control, recording the reason, optional expiration, and any compensating control.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "controlTestId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "remediated", "accepted" ] }, "reason": { "type": "string", "minLength": 1 }, "reviewedBy": { "type": "string" }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "compensatingControl": { "type": "string" } }, "required": [ "reason" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "controlTestId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "remediated", "accepted" ] }, "reason": { "type": "string" }, "reviewedBy": { "type": "string" }, "expiresAt": { "type": "string" }, "compensatingControl": { "type": "string" }, "markedByUserId": { "type": "string" }, "markedAt": { "type": "string" }, "revokedAt": { "type": "string" }, "resolvedByRunId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "status", "reason", "markedByUserId", "markedAt" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_controls_controlid_exceptions", "summary": "List control exceptions", "tags": [ "Controls" ], "description": "Returns the exceptions recorded for a control.", "parameters": [ { "schema": { "type": "string", "enum": [ "open", "remediated", "accepted" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "controlTestId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "remediated", "accepted" ] }, "reason": { "type": "string" }, "reviewedBy": { "type": "string" }, "expiresAt": { "type": "string" }, "compensatingControl": { "type": "string" }, "markedByUserId": { "type": "string" }, "markedAt": { "type": "string" }, "revokedAt": { "type": "string" }, "resolvedByRunId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "status", "reason", "markedByUserId", "markedAt" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/controls/{controlId}/exceptions/{exceptionId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_controls_controlid_exceptions_exceptionid", "summary": "Resolve a control exception", "tags": [ "Controls" ], "description": "Updates or revokes an existing control exception.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "open", "remediated", "accepted" ] }, "reason": { "type": "string", "minLength": 1 }, "reviewedBy": { "type": "string" }, "expiresAt": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "compensatingControl": { "type": "string" }, "revoke": { "type": "boolean" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "controlId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "exceptionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "controlId": { "type": "string" }, "controlTestId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "remediated", "accepted" ] }, "reason": { "type": "string" }, "reviewedBy": { "type": "string" }, "expiresAt": { "type": "string" }, "compensatingControl": { "type": "string" }, "markedByUserId": { "type": "string" }, "markedAt": { "type": "string" }, "revokedAt": { "type": "string" }, "resolvedByRunId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "controlId", "status", "reason", "markedByUserId", "markedAt" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/adopt": { "post": { "operationId": "post_trust_v1_organizations_organizationid_frameworks_adopt", "summary": "Adopt a framework", "tags": [ "Controls" ], "description": "Adopts a compliance framework for the organization and creates its controls using the selected starter mode.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "frameworkId": { "type": "string", "minLength": 1 }, "starterMode": { "type": "string", "enum": [ "recommended", "custom", "advanced" ] }, "scopeDescription": { "type": "string" }, "inScopeCategories": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } } }, "required": [ "frameworkId", "starterMode" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationFramework": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "frameworkId": { "type": "string" }, "status": { "type": "string", "enum": [ "planning", "active", "audit_in_progress", "attested", "archived" ] }, "controlMode": { "type": "string", "enum": [ "recommended", "advanced", "custom" ] }, "scopeDescription": { "type": "string" }, "inScopeCategories": { "type": "array", "items": { "type": "string" } }, "attestationStartedAt": { "type": "string" }, "attestationCompletedAt": { "type": "string" }, "attestationReportDocumentId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "auditPeriodStart": { "type": "string" }, "auditPeriodEnd": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "completed", "archived" ] } }, "required": [ "id", "firmName", "status" ], "additionalProperties": {} }, "dateCreated": {}, "dateUpdated": {}, "frameworkKey": { "type": "string" }, "frameworkShortName": { "type": "string" }, "frameworkName": { "type": "string" }, "frameworkVersion": { "type": "string" }, "frameworkAuthority": { "type": "string" }, "frameworkCategory": { "type": "string" }, "frameworkDescription": { "type": "string" }, "frameworkLicense": { "type": "string" } }, "required": [ "id", "organizationId", "frameworkId", "status" ], "additionalProperties": {} }, "controlsCreated": { "type": "number" }, "controlsRestored": { "type": "number" } }, "required": [ "organizationFramework", "controlsCreated", "controlsRestored" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/{organizationFrameworkId}/control-mode": { "post": { "operationId": "post_trust_v1_organizations_organizationid_frameworks_organizationframeworkid_control_mode", "summary": "Set a framework control mode", "tags": [ "Controls" ], "description": "Switches a framework between the recommended control set and the more granular advanced control set.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string", "enum": [ "recommended", "advanced" ] }, "keepTouched": { "type": "boolean" } }, "required": [ "mode" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "organizationFrameworkId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "mode": { "type": "string" }, "added": { "type": "number" }, "restored": { "type": "number" }, "archived": { "type": "number" }, "evidenceCopied": { "type": "number" } }, "required": [ "mode", "added", "restored", "archived", "evidenceCopied" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/{organizationFrameworkId}": { "patch": { "operationId": "patch_trust_v1_organizations_organizationid_frameworks_organizationframeworkid", "summary": "Update an adopted framework", "tags": [ "Controls" ], "description": "Updates an adopted framework, such as its status, scope, or attestation details.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "planning", "active", "audit_in_progress", "attested", "archived" ] }, "scopeDescription": { "type": "string" }, "inScopeCategories": { "minItems": 1, "type": "array", "items": { "type": "string", "minLength": 1 } }, "attestationStartedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "attestationCompletedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "attestationReportDocumentId": { "type": "string" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "organizationFrameworkId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "frameworkId": { "type": "string" }, "status": { "type": "string", "enum": [ "planning", "active", "audit_in_progress", "attested", "archived" ] }, "controlMode": { "type": "string", "enum": [ "recommended", "advanced", "custom" ] }, "scopeDescription": { "type": "string" }, "inScopeCategories": { "type": "array", "items": { "type": "string" } }, "attestationStartedAt": { "type": "string" }, "attestationCompletedAt": { "type": "string" }, "attestationReportDocumentId": { "type": "string" }, "audit": { "type": "object", "properties": { "id": { "type": "string" }, "firmName": { "type": "string" }, "auditPeriodStart": { "type": "string" }, "auditPeriodEnd": { "type": "string" }, "status": { "type": "string", "enum": [ "active", "completed", "archived" ] } }, "required": [ "id", "firmName", "status" ], "additionalProperties": {} }, "dateCreated": {}, "dateUpdated": {}, "frameworkKey": { "type": "string" }, "frameworkShortName": { "type": "string" }, "frameworkName": { "type": "string" }, "frameworkVersion": { "type": "string" }, "frameworkAuthority": { "type": "string" }, "frameworkCategory": { "type": "string" }, "frameworkDescription": { "type": "string" }, "frameworkLicense": { "type": "string" } }, "required": [ "id", "organizationId", "frameworkId", "status" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/frameworks/{organizationFrameworkId}/requirements/{frameworkRequirementId}/na": { "put": { "operationId": "put_trust_v1_organizations_organizationid_frameworks_organizationframeworkid_requirements_frameworkrequirementid_na", "summary": "Set a requirement as not applicable", "tags": [ "Controls" ], "description": "Marks a framework requirement as not applicable, or clears that status, with an optional justification.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "notApplicable": { "type": "boolean" }, "notApplicableJustification": { "type": "string" }, "ownerNote": { "type": "string" } }, "required": [ "notApplicable" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "organizationFrameworkId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "frameworkRequirementId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "organizationFrameworkId": { "type": "string" }, "frameworkRequirementId": { "type": "string" }, "notApplicable": { "type": "boolean" }, "notApplicableJustification": { "type": "string" }, "ownerNote": { "type": "string" }, "updatedByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "organizationId", "organizationFrameworkId", "frameworkRequirementId", "notApplicable", "updatedByUserId" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks", "summary": "Create a risk", "tags": [ "Risks" ], "description": "Creates a risk record in the organization risk register.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "key": { "type": "string", "minLength": 1, "maxLength": 64 }, "riskTemplateId": { "type": "string" }, "title": { "type": "string", "minLength": 1, "maxLength": 256 }, "description": { "type": "string", "maxLength": 4000 }, "category": { "type": "string", "minLength": 1, "maxLength": 64 }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "inherentImpact": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string", "maxLength": 4000 }, "treatmentTargetDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "treatmentCompletedDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "residualLikelihood": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "residualImpact": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "controlIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ] } }, "ruleId": { "type": "string" } }, "required": [ "title" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_risks", "summary": "List risks", "tags": [ "Risks" ], "description": "Returns the risks in the organization risk register.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "ownerUserId", "required": false }, { "schema": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "in": "query", "name": "treatmentStrategy", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "controlId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "vendorId", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/export": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risks_export", "summary": "Export risks", "tags": [ "Risks" ], "description": "Returns the organization risks as CSV data.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string" } }, "required": [ "csv" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/import": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks_import", "summary": "Import risks", "tags": [ "Risks" ], "description": "Imports risks from a CSV file into the organization risk register.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "csv": { "type": "string", "minLength": 1, "maxLength": 5000000 } }, "required": [ "csv" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "number" }, "updated": { "type": "number" }, "errors": { "type": "array", "items": { "type": "object", "properties": { "row": { "type": "number" }, "message": { "type": "string" } }, "required": [ "row", "message" ], "additionalProperties": false } } }, "required": [ "created", "updated", "errors" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/summary": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risks_summary", "summary": "Get risk summary", "tags": [ "Risks" ], "description": "Returns heatmap data and counts for the organization risks.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "scaleMax": { "type": "number" }, "bands": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false } }, "inherentMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "residualMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "countsByBand": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "color": { "type": "string" }, "count": { "type": "number" } }, "required": [ "label", "color", "count" ], "additionalProperties": false } }, "total": { "type": "number" }, "risksWithControl": { "type": "number" }, "overdue": { "type": "number" } }, "required": [ "scaleMax", "bands", "inherentMatrix", "residualMatrix", "countsByBand", "total", "risksWithControl", "overdue" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/add-from-templates": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks_add_from_templates", "summary": "Import risks from templates", "tags": [ "Risks" ], "description": "Creates risks in the organization from the selected risk templates.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateIds": { "minItems": 1, "maxItems": 500, "type": "array", "items": { "type": "string", "minLength": 1 } }, "ownerUserId": { "type": "string", "minLength": 1 } }, "required": [ "templateIds" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "created": { "type": "number" }, "skipped": { "type": "number" }, "risks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } } }, "required": [ "created", "skipped", "risks" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/reports": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks_reports", "summary": "Generate a risk report", "tags": [ "Risks" ], "description": "Freezes a point-in-time risk assessment snapshot.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 256 }, "notes": { "type": "string", "maxLength": 2000 } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" }, "notes": { "type": "string" }, "generatedAt": {}, "generatedByUserId": { "type": "string" }, "riskCount": { "type": "number" }, "summary": { "type": "object", "properties": { "scaleMax": { "type": "number" }, "bands": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false } }, "inherentMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "residualMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "countsByBand": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "color": { "type": "string" }, "count": { "type": "number" } }, "required": [ "label", "color", "count" ], "additionalProperties": false } }, "total": { "type": "number" }, "risksWithControl": { "type": "number" }, "overdue": { "type": "number" } }, "required": [ "scaleMax", "bands", "inherentMatrix", "residualMatrix", "countsByBand", "total", "risksWithControl", "overdue" ], "additionalProperties": false }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "controlCount": { "type": "number" }, "nextReviewDueAt": {} }, "required": [ "key", "title", "status", "treatmentStrategy", "controlCount" ], "additionalProperties": false } }, "documentId": { "type": "string" }, "assetId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "title", "generatedAt", "riskCount", "summary", "rows" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "get": { "operationId": "get_trust_v1_organizations_organizationid_risks_reports", "summary": "List risk reports", "tags": [ "Risks" ], "description": "Lists the organization point-in-time risk reports, newest first.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" }, "notes": { "type": "string" }, "generatedAt": {}, "generatedByUserId": { "type": "string" }, "riskCount": { "type": "number" }, "documentId": { "type": "string" }, "assetId": { "type": "string" }, "dateCreated": {} }, "required": [ "id", "organizationId", "title", "generatedAt", "riskCount" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/reports/{reportId}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risks_reports_reportid", "summary": "Get a risk report", "tags": [ "Risks" ], "description": "Returns a single point-in-time risk report with its snapshot.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" }, "notes": { "type": "string" }, "generatedAt": {}, "generatedByUserId": { "type": "string" }, "riskCount": { "type": "number" }, "summary": { "type": "object", "properties": { "scaleMax": { "type": "number" }, "bands": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false } }, "inherentMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "residualMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "countsByBand": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "color": { "type": "string" }, "count": { "type": "number" } }, "required": [ "label", "color", "count" ], "additionalProperties": false } }, "total": { "type": "number" }, "risksWithControl": { "type": "number" }, "overdue": { "type": "number" } }, "required": [ "scaleMax", "bands", "inherentMatrix", "residualMatrix", "countsByBand", "total", "risksWithControl", "overdue" ], "additionalProperties": false }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "controlCount": { "type": "number" }, "nextReviewDueAt": {} }, "required": [ "key", "title", "status", "treatmentStrategy", "controlCount" ], "additionalProperties": false } }, "documentId": { "type": "string" }, "assetId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "title", "generatedAt", "riskCount", "summary", "rows" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_risks_reports_reportid", "summary": "Delete a risk report", "tags": [ "Risks" ], "description": "Deletes a risk report and its stored PDF document.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/reports/{reportId}/download": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risks_reports_reportid_download", "summary": "Download a risk report PDF", "tags": [ "Risks" ], "description": "Renders the frozen snapshot as a branded PDF and streams it back.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/organizations/{organizationId}/risks/reports/{reportId}/document": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks_reports_reportid_document", "summary": "Save a risk report PDF to Documents", "tags": [ "Risks" ], "description": "Renders the frozen snapshot, stores it as a report document, and links it to the report.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "title": { "type": "string" }, "notes": { "type": "string" }, "generatedAt": {}, "generatedByUserId": { "type": "string" }, "riskCount": { "type": "number" }, "summary": { "type": "object", "properties": { "scaleMax": { "type": "number" }, "bands": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false } }, "inherentMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "residualMatrix": { "type": "array", "items": { "type": "object", "properties": { "likelihood": { "type": "number" }, "impact": { "type": "number" }, "score": { "type": "number" }, "band": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "count": { "type": "number" } }, "required": [ "likelihood", "impact", "score", "count" ], "additionalProperties": false } }, "countsByBand": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "color": { "type": "string" }, "count": { "type": "number" } }, "required": [ "label", "color", "count" ], "additionalProperties": false } }, "total": { "type": "number" }, "risksWithControl": { "type": "number" }, "overdue": { "type": "number" } }, "required": [ "scaleMax", "bands", "inherentMatrix", "residualMatrix", "countsByBand", "total", "risksWithControl", "overdue" ], "additionalProperties": false }, "rows": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "title": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "controlCount": { "type": "number" }, "nextReviewDueAt": {} }, "required": [ "key", "title", "status", "treatmentStrategy", "controlCount" ], "additionalProperties": false } }, "documentId": { "type": "string" }, "assetId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "title", "generatedAt", "riskCount", "summary", "rows" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/{riskId}": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risks_riskid", "summary": "Get a risk", "tags": [ "Risks" ], "description": "Returns a single risk by ID.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "riskId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_risks_riskid", "summary": "Update a risk", "tags": [ "Risks" ], "description": "Updates fields on an existing risk.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1, "maxLength": 256 }, "description": { "type": "string", "maxLength": 4000 }, "category": { "type": "string", "minLength": 1, "maxLength": 64 }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "inherentImpact": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string", "maxLength": 4000 }, "treatmentTargetDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "treatmentCompletedDate": { "anyOf": [ { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, { "type": "string", "enum": [ "" ] } ] }, "residualLikelihood": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "residualImpact": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 5 }, { "type": "string", "enum": [ "" ] } ] }, "controlIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "addControlIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } }, "removeControlIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "riskId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "delete": { "operationId": "delete_trust_v1_organizations_organizationid_risks_riskid", "summary": "Delete a risk", "tags": [ "Risks" ], "description": "Deletes a risk from the organization risk register.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "riskId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": [ "success" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/{riskId}/review": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks_riskid_review", "summary": "Record a risk review", "tags": [ "Risks" ], "description": "Records a reassessment of a risk, including its updated likelihood and impact scores.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "inherentLikelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "inherentImpact": { "type": "integer", "minimum": 1, "maximum": 5 }, "residualLikelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "residualImpact": { "type": "integer", "minimum": 1, "maximum": 5 } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "riskId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risks/{riskId}/controls": { "post": { "operationId": "post_trust_v1_organizations_organizationid_risks_riskid_controls", "summary": "Link controls to a risk", "tags": [ "Risks" ], "description": "Adds or removes controls linked to a risk.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "addControlIds": { "maxItems": 500, "type": "array", "items": { "type": "string", "minLength": 1 } }, "removeControlIds": { "maxItems": 500, "type": "array", "items": { "type": "string", "minLength": 1 } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "riskId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "ownerUserId": { "type": "string" }, "status": { "type": "string", "enum": [ "open", "closed", "archived" ] }, "inherentLikelihood": { "type": "number" }, "inherentImpact": { "type": "number" }, "inherentScore": { "type": "number" }, "inherentBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "treatmentStrategy": { "type": "string", "enum": [ "untreated", "mitigate", "accept", "transfer", "avoid" ] }, "treatmentRationale": { "type": "string" }, "treatmentTargetDate": {}, "treatmentCompletedDate": {}, "residualLikelihood": { "type": "number" }, "residualImpact": { "type": "number" }, "residualScore": { "type": "number" }, "residualBand": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false }, "controlIds": { "type": "array", "items": { "type": "string" } }, "vendorId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "ruleId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "key", "title", "status", "treatmentStrategy", "reviewFrequency" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risk-templates": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risk_templates", "summary": "List risk templates", "tags": [ "Risks" ], "description": "Returns the risk templates available to the organization.", "parameters": [ { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string", "enum": [ "nist_800_30", "iso_27005", "ocr_sra" ] }, "in": "query", "name": "sourceFramework", "required": false }, { "schema": { "type": "string", "enum": [ "active", "archived" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "key": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "category": { "type": "string" }, "suggestedLikelihood": { "type": "number" }, "suggestedImpact": { "type": "number" }, "recommendedControlTemplateKeys": { "type": "array", "items": { "type": "string" } }, "sourceFramework": { "type": "string", "enum": [ "nist_800_30", "iso_27005", "ocr_sra" ] }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "key", "title", "description", "category", "status" ], "additionalProperties": {} } }, "total": { "type": "number" } }, "required": [ "items", "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/risk-scoring-config": { "get": { "operationId": "get_trust_v1_organizations_organizationid_risk_scoring_config", "summary": "Get risk scoring config", "tags": [ "Risks" ], "description": "Returns the risk scoring configuration for the organization.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "bands": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "bands" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } }, "patch": { "operationId": "patch_trust_v1_organizations_organizationid_risk_scoring_config", "summary": "Update risk scoring config", "tags": [ "Risks" ], "description": "Updates the risk scoring configuration for the organization, such as its scale or severity bands.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "bands": { "minItems": 1, "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ] } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "bands": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 64 }, "min": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "color": { "type": "string", "minLength": 1, "maxLength": 32 } }, "required": [ "label", "min", "max", "color" ], "additionalProperties": false } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "bands" ], "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/report-branding": { "get": { "operationId": "get_trust_v1_organizations_organizationid_report_branding", "summary": "Resolved report branding", "tags": [ "Branding" ], "description": "Resolved org branding for PDF exports (logo rasterized to PNG) plus the per-export branding toggles.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "logoUrl": { "type": "string" }, "primaryColor": { "type": "string" }, "secondaryColor": { "type": "string" }, "poweredByConcord": { "type": "boolean" }, "brandRiskReport": { "type": "boolean" }, "brandRopaReport": { "type": "boolean" }, "brandQuestionnaire": { "type": "boolean" }, "brandDocumentExport": { "type": "boolean" } }, "additionalProperties": {} } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } } }, "servers": [ { "url": "https://api.concord.tech/trust-v1", "description": "Concord Trust API" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Controls", "description": "Controls, coverage, and evaluation." }, { "name": "Trust Centers", "description": "Trust center projects: configuration, compliance badges, and published content." }, { "name": "Auditor", "description": "Auditor portal review workflow." }, { "name": "Risks", "description": "The risk register: risks, scoring, treatments, templates, and CSV import/export." }, { "name": "Trust Audience", "description": "Trust center audience: allowed viewer domains and emails for gated content." }, { "name": "Branding", "description": "Resolved organization branding for report exports." }, { "name": "Trust Subscriptions", "description": "Trust plan and capacity endpoints." } ] }