{ "openapi": "3.1.0", "info": { "title": "Concord Platform API", "description": "The Concord Platform API hosts the cross-product surfaces shared by the Privacy and Trust products, such as documents, forms, and actions.", "version": "4.22.2", "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": { "__schema0": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "field-equals" ] }, "field": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "type", "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "field-not-equals" ] }, "field": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "type", "field", "value" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "field-truthy" ] }, "field": { "type": "string" } }, "required": [ "type", "field" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "array-not-empty" ] }, "field": { "type": "string" } }, "required": [ "type", "field" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "and" ] }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/__schema0" } } }, "required": [ "type", "conditions" ], "additionalProperties": false }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "or" ] }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/__schema0" } } }, "required": [ "type", "conditions" ], "additionalProperties": false } ] }, "__schema02": { "oneOf": [ { "type": "object", "properties": { "type": { "type": "string", "enum": [ "field-equals" ] }, "field": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "type", "field", "value" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "field-not-equals" ] }, "field": { "type": "string" }, "value": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "number" } ] } }, "required": [ "type", "field", "value" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "field-truthy" ] }, "field": { "type": "string" } }, "required": [ "type", "field" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "array-not-empty" ] }, "field": { "type": "string" } }, "required": [ "type", "field" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "and" ] }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/__schema02" } } }, "required": [ "type", "conditions" ] }, { "type": "object", "properties": { "type": { "type": "string", "enum": [ "or" ] }, "conditions": { "type": "array", "items": { "$ref": "#/components/schemas/__schema02" } } }, "required": [ "type", "conditions" ] } ] } } }, "paths": { "/organizations/{organizationId}/documents": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents", "summary": "List organization documents", "tags": [ "Documents" ], "description": "Lists documents across all projects in an organization with filtering", "parameters": [ { "schema": { "anyOf": [ { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda" ] }, { "type": "array", "items": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda" ] } } ] }, "in": "query", "name": "type", "required": false }, { "schema": { "type": "string", "enum": [ "active", "archived" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "in": "query", "name": "accessLevel", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "policyType", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "tags", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "excludeTags", "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" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } }, "post": { "operationId": "post_platform_v1_organizations_organizationid_documents", "summary": "Create a document", "tags": [ "Documents" ], "description": "Creates a new document in an organization", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "policyType": { "type": "string", "maxLength": 256 }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "question": { "type": "string" }, "url": { "type": "string", "format": "uri" }, "assets": { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": false } }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "publishedBy": { "type": "string", "maxLength": 256 } }, "required": [ "name", "type" ], "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" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid", "summary": "Get an organization document", "tags": [ "Documents" ], "description": "Gets a single document by ID within an organization", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } }, "patch": { "operationId": "patch_platform_v1_organizations_organizationid_documents_documentid", "summary": "Update a document", "tags": [ "Documents" ], "description": "Updates a document 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": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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_platform_v1_organizations_organizationid_documents_documentid", "summary": "Delete a document", "tags": [ "Documents" ], "description": "Deletes a document by ID", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "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}/documents/{documentId}/archive": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_archive", "summary": "Archive a document", "tags": [ "Documents" ], "description": "Soft-deletes a document by flipping its status to `archived`. The document and its release history stay intact; archived docs are hidden from public trust-center surfaces and from admin list views that pass `status: 'active'`. Reversible via the matching unarchive route.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}/unarchive": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_unarchive", "summary": "Restore an archived document", "tags": [ "Documents" ], "description": "Reverses `archive` by flipping the document status back to `active`. The publish pointer is untouched, so a previously- published doc returns to public trust-center surfaces immediately.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } } }, "/organizations/{organizationId}/faq-import/parse-upload": { "post": { "operationId": "post_platform_v1_organizations_organizationid_faq_import_parse_upload", "summary": "Parse a FAQ spreadsheet upload (returns rows without persisting)", "tags": [ "Documents" ], "description": "Multipart file upload (CSV/XLSX/XLS/XLSM) that extracts Q&A rows for admin review. No documents are created — pair this with the POST .../faq-import route to persist the reviewed rows in bulk.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "format": { "type": "string" }, "rows": { "type": "array", "items": { "type": "object", "properties": { "question": { "type": "string" }, "answer": { "type": "string" }, "tags": { "type": "array", "items": { "type": "string" } } }, "required": [ "question", "answer", "tags" ], "additionalProperties": false } }, "matrix": { "type": "array", "items": { "type": "array", "items": { "type": "string" } } }, "detectedHeader": { "type": "boolean" }, "mapping": { "type": "object", "properties": { "question": { "type": "integer", "minimum": 0 }, "answer": { "oneOf": [ { "type": "integer" } ] }, "tags": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "question", "answer", "tags" ], "additionalProperties": false } }, "required": [ "name", "format", "rows", "matrix", "detectedHeader", "mapping" ], "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}/faq-import": { "post": { "operationId": "post_platform_v1_organizations_organizationid_faq_import", "summary": "Bulk-create FAQ documents from a reviewed row set", "tags": [ "Documents" ], "description": "Pairs with POST .../faq-import/parse-upload. Body carries the admin-edited rows + bulk status/access to apply to every row. Each row becomes one FAQ document; rows with non-empty answers also get an inline markdown asset carrying the answer body.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "rows": { "type": "array", "minItems": 1, "maxItems": 1000, "items": { "type": "object", "properties": { "question": { "type": "string" }, "answer": { "type": "string" }, "tags": { "type": "array", "maxItems": 20, "items": { "type": "string", "maxLength": 64 } } }, "required": [ "question" ], "additionalProperties": false } }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "language": { "type": "string" }, "publishedBy": { "type": "string", "maxLength": 256 } }, "required": [ "rows", "status", "accessLevel" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdCount": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "string" } } }, "required": [ "createdCount", "ids" ], "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}/assets": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_assets", "summary": "Add asset to document", "tags": [ "Documents" ], "description": "Adds text content to a document. Files are added through the upload route.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assetId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "language": { "type": "string" }, "body": { "type": "string" }, "publishedBy": { "type": "string", "maxLength": 256 }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx" ] } }, "required": [ "format" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "size": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "format", "version", "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}/documents/{documentId}/assets/upload": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_assets_upload", "summary": "Upload asset file to document", "tags": [ "Documents" ], "description": "Uploads a file as a new asset for a document. The file is stored in S3 and the asset metadata is created automatically.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "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}/documents/{documentId}/assets/{assetId}": { "patch": { "operationId": "patch_platform_v1_organizations_organizationid_documents_documentid_assets_assetid", "summary": "Update asset", "tags": [ "Documents" ], "description": "Updates an asset 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": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "assetId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "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_platform_v1_organizations_organizationid_documents_documentid_assets_assetid", "summary": "Delete asset", "tags": [ "Documents" ], "description": "Deletes an asset from a document", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "assetId", "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}/documents/{documentId}/downloads/{assetId}/presigned": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid_downloads_assetid_presigned", "summary": "Get presigned download URL", "tags": [ "Documents" ], "description": "Gets a presigned S3 URL for downloading an asset", "parameters": [ { "schema": { "type": "string", "enum": [ "inline", "attachment" ] }, "in": "query", "name": "disposition", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "assetId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "type": "string", "format": "uri" }, "expiresIn": { "type": "integer" } }, "required": [ "url", "expiresIn" ], "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}/downloads/{assetId}/html": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid_downloads_assetid_html", "summary": "Render a Word (.docx) asset to HTML for preview", "tags": [ "Documents" ], "description": "Renders a Word (.docx) asset to HTML for preview.", "parameters": [ { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "assetId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "html": { "type": "string" } }, "required": [ "html" ], "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}/template-status": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid_template_status", "summary": "Get a policy document's source-template status", "tags": [ "Documents" ], "description": "Whether a newer template version is available and the data needed to adopt it (recommended controls, prior form answers).", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "policyType": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "templateId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "templateSource": { "anyOf": [ { "type": "string", "enum": [ "global", "org" ] }, { "type": "null" } ] }, "templateName": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "templateVersion": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "policyTemplateVersion": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "hasFormSubmission": { "type": "boolean" }, "updateAvailable": { "type": "boolean" } }, "required": [ "policyType", "templateId", "templateSource", "templateName", "templateVersion", "policyTemplateVersion", "recommendedControlKeys", "hasFormSubmission", "updateAvailable" ], "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}/regenerate": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_regenerate", "summary": "Regenerate a policy from its current template version", "tags": [ "Documents" ], "description": "Re-renders the policy body from the current template (with previous or freshly re-entered answers), overwrites the content, and mints a revertable release.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "submissionId": { "type": "string", "format": "uuid" }, "publishedBy": { "type": "string" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}/regenerate-preview": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_regenerate_preview", "summary": "Preview regenerating a policy", "tags": [ "Documents" ], "description": "Renders the policy body that regenerating with these answers would produce, without saving anything.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateSource": { "type": "string", "enum": [ "global", "org" ] }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} } }, "required": [ "templateId", "templateSource", "answers" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "language": { "type": "string" }, "body": { "type": "string" }, "edits": { "anyOf": [ { "type": "object", "properties": { "kept": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "overlapping": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "kept", "overlapping" ], "additionalProperties": false }, { "type": "null" } ] } }, "required": [ "language", "body", "edits" ], "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}/releases": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_releases", "summary": "Publish a document — mint a new immutable release", "tags": [ "Documents" ], "description": "Snapshots the current draft state of a document into a new `documentReleases` row. The release is what the KB indexer reads from, not the live draft. Patching the document after publish does not affect the release.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "publishedBy": { "type": "string" }, "releaseNotes": { "type": "string", "maxLength": 2000 } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "publishedAt": { "type": "integer" }, "publishedBy": { "type": "string" }, "releaseNotes": { "type": "string", "maxLength": 2000 }, "snapshot": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "policyType": { "type": "string", "maxLength": 256 }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "name", "type", "accessLevel", "assets" ], "additionalProperties": false }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "documentId", "organizationId", "version", "publishedAt", "publishedBy", "snapshot", "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_platform_v1_organizations_organizationid_documents_documentid_releases", "summary": "List document releases (newest first)", "tags": [ "Documents" ], "description": "Lists document releases, newest first.", "parameters": [ { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 200 }, "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": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "publishedAt": { "type": "integer" }, "publishedBy": { "type": "string" }, "releaseNotes": { "type": "string", "maxLength": 2000 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "documentId", "organizationId", "version", "publishedAt", "publishedBy", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total", "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}/documents/{documentId}/releases/{releaseId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid_releases_releaseid", "summary": "Get a single document release with full snapshot", "tags": [ "Documents" ], "description": "Gets a single document release with its full snapshot.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "releaseId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "publishedAt": { "type": "integer" }, "publishedBy": { "type": "string" }, "releaseNotes": { "type": "string", "maxLength": 2000 }, "snapshot": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "policyType": { "type": "string", "maxLength": 256 }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "name", "type", "accessLevel", "assets" ], "additionalProperties": false }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "documentId", "organizationId", "version", "publishedAt", "publishedBy", "snapshot", "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_platform_v1_organizations_organizationid_documents_documentid_releases_releaseid", "summary": "Delete a non-current document release", "tags": [ "Documents" ], "description": "Deletes a non-current document release.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "releaseId", "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}/documents/{documentId}/releases/{releaseId}/restore": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_releases_releaseid_restore", "summary": "Restore an old release — mint a new release from its snapshot", "tags": [ "Documents" ], "description": "Append-only restore. Doesn't repoint `publishedReleaseId` back at the old row; instead mints a new release whose snapshot equals the chosen one. History stays strictly append-only (\"v5 published, snapshot equals v3\").", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "publishedBy": { "type": "string" }, "releaseNotes": { "type": "string", "minLength": 1, "maxLength": 2000 } }, "required": [ "releaseNotes" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "releaseId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "documentId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "version": { "type": "integer", "minimum": 1 }, "publishedAt": { "type": "integer" }, "publishedBy": { "type": "string" }, "releaseNotes": { "type": "string", "maxLength": 2000 }, "snapshot": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "policyType": { "type": "string", "maxLength": 256 }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "name", "type", "accessLevel", "assets" ], "additionalProperties": false }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "documentId", "organizationId", "version", "publishedAt", "publishedBy", "snapshot", "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}/documents/{documentId}/enrich": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_enrich", "summary": "Kick an AI enrichment pass on a policy document", "tags": [ "Documents" ], "description": "Tier-gated by advancedPolicies. Creates an open suggestion shell and dispatches the enrich-policy AI job; the filled blocks are polled via the suggestions endpoint.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "source": { "type": "string", "enum": [ "ai_enrich", "ai_import_review" ] }, "requestedByUserId": { "type": "string" } }, "required": [ "requestedByUserId" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "baseReleaseId": { "type": "string" }, "source": { "type": "string", "enum": [ "ai_enrich", "ai_import_review" ] }, "status": { "type": "string", "enum": [ "open", "applied", "discarded" ] }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "anchor": { "type": "string" }, "proposed": { "type": "string" }, "rationale": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "rejected" ] }, "decidedByUserId": { "type": "string" }, "decidedAt": {} }, "required": [ "anchor", "proposed", "status" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "baseReleaseId", "source", "status", "blocks" ], "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}/suggestions": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid_suggestions", "summary": "List a document's AI suggestions (defaults to open)", "tags": [ "Documents" ], "description": "Lists a document's AI suggestions, open ones by default.", "parameters": [ { "schema": { "type": "string", "enum": [ "open", "applied", "discarded" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "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": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "baseReleaseId": { "type": "string" }, "source": { "type": "string", "enum": [ "ai_enrich", "ai_import_review" ] }, "status": { "type": "string", "enum": [ "open", "applied", "discarded" ] }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "anchor": { "type": "string" }, "proposed": { "type": "string" }, "rationale": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "rejected" ] }, "decidedByUserId": { "type": "string" }, "decidedAt": {} }, "required": [ "anchor", "proposed", "status" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "baseReleaseId", "source", "status", "blocks" ], "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}/documents/{documentId}/suggestions/{suggestionId}/decide": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_suggestions_suggestionid_decide", "summary": "Accept/reject suggestion blocks (accepting mints a release)", "tags": [ "Documents" ], "description": "Per-block accept/reject. Tier-gated by advancedPolicies. Accepting applies the accepted blocks to the document and mints a release recording who decided what; rejecting discards.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "decidedByUserId": { "type": "string" }, "decisions": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "anchor": { "type": "string", "minLength": 1 }, "decision": { "type": "string", "enum": [ "accept", "reject" ] } }, "required": [ "anchor", "decision" ], "additionalProperties": false } } }, "required": [ "decidedByUserId", "decisions" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "suggestionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "baseReleaseId": { "type": "string" }, "source": { "type": "string", "enum": [ "ai_enrich", "ai_import_review" ] }, "status": { "type": "string", "enum": [ "open", "applied", "discarded" ] }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "anchor": { "type": "string" }, "proposed": { "type": "string" }, "rationale": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "rejected" ] }, "decidedByUserId": { "type": "string" }, "decidedAt": {} }, "required": [ "anchor", "proposed", "status" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "baseReleaseId", "source", "status", "blocks" ], "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}/approval/request": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_approval_request", "summary": "Open an approval round on a policy document", "tags": [ "Documents" ], "description": "Tier-gated by advancedPolicies. Opens a quorum approval, requested by the signed-in user, with the given named tiers; publish stays blocked until every required tier approves.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "note": { "type": "string", "maxLength": 2000 }, "tiers": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 120 }, "approverUserIds": { "type": "array", "minItems": 1, "items": { "type": "string", "minLength": 1 } }, "minApprovals": { "type": "integer", "default": 1, "minimum": 1 } }, "required": [ "name", "approverUserIds" ], "additionalProperties": false } } }, "required": [ "tiers" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "changes_requested", "cancelled" ] }, "requestedByUserId": { "type": "string" }, "note": { "type": "string" }, "tiers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "approverUserIds": { "type": "array", "items": { "type": "string" } }, "minApprovals": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "decisions": { "type": "array", "items": { "type": "object", "properties": { "decidedByUserId": { "type": "string" }, "verdict": { "type": "string", "enum": [ "approve", "request_changes" ] }, "comment": { "type": "string" }, "decidedAt": {} }, "required": [ "decidedByUserId", "verdict" ], "additionalProperties": {} } } }, "required": [ "name", "approverUserIds", "minApprovals", "decisions" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "status", "requestedByUserId", "tiers" ], "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}/approval/decision": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_approval_decision", "summary": "Record one approver's verdict on an approval tier", "tags": [ "Documents" ], "description": "Tier-gated by advancedPolicies. The verdict is recorded for the signed-in user. `request_changes` returns the document to draft; once every required tier reaches quorum publish is unblocked.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "tierName": { "type": "string", "minLength": 1 }, "verdict": { "type": "string", "enum": [ "approve", "request_changes" ] }, "comment": { "type": "string", "maxLength": 2000 } }, "required": [ "tierName", "verdict" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "changes_requested", "cancelled" ] }, "requestedByUserId": { "type": "string" }, "note": { "type": "string" }, "tiers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "approverUserIds": { "type": "array", "items": { "type": "string" } }, "minApprovals": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "decisions": { "type": "array", "items": { "type": "object", "properties": { "decidedByUserId": { "type": "string" }, "verdict": { "type": "string", "enum": [ "approve", "request_changes" ] }, "comment": { "type": "string" }, "decidedAt": {} }, "required": [ "decidedByUserId", "verdict" ], "additionalProperties": {} } } }, "required": [ "name", "approverUserIds", "minApprovals", "decisions" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "status", "requestedByUserId", "tiers" ], "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}/approval/cancel": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_approval_cancel", "summary": "Withdraw the in-flight approval round", "tags": [ "Documents" ], "description": "Tier-gated by advancedPolicies. Only the requester may cancel; the round flips to `cancelled` and the document is untouched.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "changes_requested", "cancelled" ] }, "requestedByUserId": { "type": "string" }, "note": { "type": "string" }, "tiers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "approverUserIds": { "type": "array", "items": { "type": "string" } }, "minApprovals": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "decisions": { "type": "array", "items": { "type": "object", "properties": { "decidedByUserId": { "type": "string" }, "verdict": { "type": "string", "enum": [ "approve", "request_changes" ] }, "comment": { "type": "string" }, "decidedAt": {} }, "required": [ "decidedByUserId", "verdict" ], "additionalProperties": {} } } }, "required": [ "name", "approverUserIds", "minApprovals", "decisions" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "status", "requestedByUserId", "tiers" ], "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}/approval": { "get": { "operationId": "get_platform_v1_organizations_organizationid_documents_documentid_approval", "summary": "List a document's approval rounds (newest first)", "tags": [ "Documents" ], "description": "Lists a document's approval rounds, newest first.", "parameters": [ { "schema": { "type": "string", "enum": [ "pending", "approved", "changes_requested", "cancelled" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "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": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "approved", "changes_requested", "cancelled" ] }, "requestedByUserId": { "type": "string" }, "note": { "type": "string" }, "tiers": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "approverUserIds": { "type": "array", "items": { "type": "string" } }, "minApprovals": { "type": "integer", "minimum": 1, "maximum": 9007199254740991 }, "decisions": { "type": "array", "items": { "type": "object", "properties": { "decidedByUserId": { "type": "string" }, "verdict": { "type": "string", "enum": [ "approve", "request_changes" ] }, "comment": { "type": "string" }, "decidedAt": {} }, "required": [ "decidedByUserId", "verdict" ], "additionalProperties": {} } } }, "required": [ "name", "approverUserIds", "minApprovals", "decisions" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "status", "requestedByUserId", "tiers" ], "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}/documents/import": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_import", "summary": "Import an uploaded file as a policy document (as-is)", "tags": [ "Documents" ], "description": "Formalizes an already-uploaded file (asset/file path) into a `type:'policy'` Document. Counts against the plan's policies allowance.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "projectId": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string", "minLength": 1 }, "key": { "type": "string", "minLength": 1 }, "size": { "type": "integer", "minimum": 0 }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": true }, "submittedBy": { "type": "string" } }, "required": [ "name", "file", "submittedBy" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "status", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } } }, "/organizations/{organizationId}/documents/{documentId}/import/review": { "post": { "operationId": "post_platform_v1_organizations_organizationid_documents_documentid_import_review", "summary": "Run an AI gap-review pass over an imported policy", "tags": [ "Documents" ], "description": "Tier-gated by advancedPolicies. Extracts the imported file text and dispatches the gap-review pass, returning a suggestion shell to poll.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "requestedByUserId": { "type": "string" }, "orgFacts": { "type": "string", "maxLength": 8000 } }, "required": [ "requestedByUserId" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "documentId": { "type": "string" }, "baseReleaseId": { "type": "string" }, "source": { "type": "string", "enum": [ "ai_enrich", "ai_import_review" ] }, "status": { "type": "string", "enum": [ "open", "applied", "discarded" ] }, "blocks": { "type": "array", "items": { "type": "object", "properties": { "anchor": { "type": "string" }, "proposed": { "type": "string" }, "rationale": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted", "rejected" ] }, "decidedByUserId": { "type": "string" }, "decidedAt": {} }, "required": [ "anchor", "proposed", "status" ], "additionalProperties": {} } }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "documentId", "baseReleaseId", "source", "status", "blocks" ], "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}/branding": { "get": { "operationId": "get_platform_v1_organizations_organizationid_branding", "summary": "Get organization branding", "tags": [ "Organizations" ], "description": "Gets the branding settings for an organization.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "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 }, "poweredByConcord": { "type": "boolean" }, "brandRiskReport": { "type": "boolean" }, "brandRopaReport": { "type": "boolean" }, "brandQuestionnaire": { "type": "boolean" }, "brandDocumentExport": { "type": "boolean" } }, "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_platform_v1_organizations_organizationid_branding", "summary": "Update organization branding", "tags": [ "Organizations" ], "description": "Updates the branding settings for an organization.", "requestBody": { "content": { "application/json": { "schema": { "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 }, "poweredByConcord": { "type": "boolean" }, "brandRiskReport": { "type": "boolean" }, "brandRopaReport": { "type": "boolean" }, "brandQuestionnaire": { "type": "boolean" }, "brandDocumentExport": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "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 }, "poweredByConcord": { "type": "boolean" }, "brandRiskReport": { "type": "boolean" }, "brandRopaReport": { "type": "boolean" }, "brandQuestionnaire": { "type": "boolean" }, "brandDocumentExport": { "type": "boolean" } }, "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}/onboarding/{flowId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_onboarding_flowid", "summary": "Get organization onboarding flow", "tags": [ "Organizations" ], "description": "Gets the conditional onboarding checklist and progress state for an organization.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "enum": [ "post-billing-setup" ] }, "in": "path", "name": "flowId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "flowId": { "enum": [ "post-billing-setup" ] }, "flowVersion": { "type": "integer", "minimum": 1 }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "completed" ] }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "percent": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "completed", "total", "percent" ], "additionalProperties": false }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "organization-branding", "invite-teammates", "data-systems", "privacy-consent-settings", "privacy-experiences", "privacy-cookie-categorization", "site-integration", "privacy-regions", "trust-center-customize", "trust-documents", "trust-center-documents", "trust-center-publish" ] }, "category": { "type": "string", "enum": [ "organization", "privacy", "trust" ] }, "title": { "type": "string", "maxLength": 160 }, "description": { "type": "string", "maxLength": 1000 }, "estimatedMinutes": { "type": "integer", "minimum": 1, "maximum": 120 }, "optional": { "type": "boolean" }, "locked": { "type": "boolean" }, "upgrade": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 80 }, "route": { "type": "string", "maxLength": 512 } }, "required": [ "label", "route" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "not_started", "completed", "skipped" ] }, "source": { "type": "string", "enum": [ "inferred", "manual" ] }, "route": { "type": "string", "maxLength": 512 }, "componentKey": { "type": "string", "maxLength": 128 }, "eligible": { "type": "boolean" }, "requiredPermission": { "type": "string", "maxLength": 128 } }, "required": [ "id", "category", "title", "description", "estimatedMinutes", "optional", "locked", "status", "eligible" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "organizationId", "flowId", "flowVersion", "status", "progress", "tasks" ], "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_platform_v1_organizations_organizationid_onboarding_flowid", "summary": "Update organization onboarding flow", "tags": [ "Organizations" ], "description": "Updates dismiss, reopen, and task progress state for an organization onboarding flow.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "task_reset", "task_skipped", "task_completed" ] }, "taskId": { "oneOf": [ { "type": "string", "enum": [ "organization-branding", "invite-teammates", "data-systems", "privacy-consent-settings", "privacy-experiences", "privacy-cookie-categorization", "site-integration", "privacy-regions", "trust-center-customize", "trust-documents", "trust-center-documents", "trust-center-publish" ] }, { "type": "string", "enum": [ "organization-branding", "invite-teammates", "data-systems", "privacy-consent-settings", "privacy-experiences", "privacy-cookie-categorization", "site-integration", "privacy-regions", "trust-center-customize", "trust-documents", "trust-center-documents", "trust-center-publish" ] } ] }, "source": { "type": "string", "enum": [ "inferred", "manual" ] } }, "required": [ "action" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "enum": [ "post-billing-setup" ] }, "in": "path", "name": "flowId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationId": { "type": "string", "format": "uuid" }, "flowId": { "enum": [ "post-billing-setup" ] }, "flowVersion": { "type": "integer", "minimum": 1 }, "status": { "type": "string", "enum": [ "not_started", "in_progress", "completed" ] }, "progress": { "type": "object", "properties": { "completed": { "type": "integer", "minimum": 0 }, "total": { "type": "integer", "minimum": 0 }, "percent": { "type": "integer", "minimum": 0, "maximum": 100 } }, "required": [ "completed", "total", "percent" ], "additionalProperties": false }, "tasks": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "enum": [ "organization-branding", "invite-teammates", "data-systems", "privacy-consent-settings", "privacy-experiences", "privacy-cookie-categorization", "site-integration", "privacy-regions", "trust-center-customize", "trust-documents", "trust-center-documents", "trust-center-publish" ] }, "category": { "type": "string", "enum": [ "organization", "privacy", "trust" ] }, "title": { "type": "string", "maxLength": 160 }, "description": { "type": "string", "maxLength": 1000 }, "estimatedMinutes": { "type": "integer", "minimum": 1, "maximum": 120 }, "optional": { "type": "boolean" }, "locked": { "type": "boolean" }, "upgrade": { "type": "object", "properties": { "label": { "type": "string", "maxLength": 80 }, "route": { "type": "string", "maxLength": 512 } }, "required": [ "label", "route" ], "additionalProperties": false }, "status": { "type": "string", "enum": [ "not_started", "completed", "skipped" ] }, "source": { "type": "string", "enum": [ "inferred", "manual" ] }, "route": { "type": "string", "maxLength": 512 }, "componentKey": { "type": "string", "maxLength": 128 }, "eligible": { "type": "boolean" }, "requiredPermission": { "type": "string", "maxLength": 128 } }, "required": [ "id", "category", "title", "description", "estimatedMinutes", "optional", "locked", "status", "eligible" ], "additionalProperties": false } }, "createdAt": { "type": "string", "format": "date-time" }, "updatedAt": { "type": "string", "format": "date-time" } }, "required": [ "organizationId", "flowId", "flowVersion", "status", "progress", "tasks" ], "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}/forms": { "get": { "operationId": "get_platform_v1_organizations_organizationid_forms", "summary": "List forms an organization can use, browse or manage", "tags": [ "Forms" ], "description": "No source: Concord’s active catalog plus the org’s own active forms (the picklist). source=global: the catalog. source=org: the org’s own forms. Each row tagged by source.", "parameters": [ { "schema": { "type": "string", "enum": [ "global", "org" ] }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "in": "query", "name": "kind", "required": false }, { "schema": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "templateSource": { "type": "string", "enum": [ "global", "org" ] }, "library": { "type": "string", "enum": [ "concord_curated", "super_admin_custom" ] }, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "templateSource" ], "additionalProperties": false } } }, "required": [ "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" ] } } } } } }, "post": { "operationId": "post_platform_v1_organizations_organizationid_forms", "summary": "Create a form from scratch", "tags": [ "Forms" ], "description": "Creates a draft form the organization owns, with no catalog source behind it", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "iconUrl": { "type": "string", "maxLength": 2048 }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ] } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ] }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema02" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ] } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ] }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema02" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ] } } }, "required": [ "condition" ] } }, "required": [ "id", "type", "order" ] } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema02" } }, "required": [ "id", "title", "order" ] } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema02" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ] } } }, "required": [ "type", "items" ] }, "kind": { "default": "custom", "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] } }, "required": [ "name", "config" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "organizationId" ], "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}/forms/{templateId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_forms_templateid", "summary": "Get one form by id from the named source", "tags": [ "Forms" ], "description": "source=global reads an active catalog template; source=org reads one of the organization’s own forms with its update-available flag.", "parameters": [ { "schema": { "type": "string", "enum": [ "global", "org" ] }, "in": "query", "name": "source", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "templateId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "templateSource": { "type": "string", "enum": [ "global", "org" ] }, "library": { "type": "string", "enum": [ "concord_curated", "super_admin_custom" ] }, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "templateSource" ], "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_platform_v1_organizations_organizationid_forms_templateid", "summary": "Edit one of the organization's own forms", "tags": [ "Forms" ], "description": "Edits a form the organization owns. Catalog templates are read-only; copy one first.", "requestBody": { "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "op": { "type": "string", "enum": [ "add", "remove", "replace" ] }, "path": { "type": "string" }, "value": {} }, "required": [ "op", "path" ] } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "templateId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "organizationId" ], "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}/forms/{templateId}/publish": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_templateid_publish", "summary": "Publish one of the organization's own forms", "tags": [ "Forms" ], "description": "Makes the draft the served version, so people in the organization can start assessments from it", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "notes": { "type": "string", "maxLength": 2000 }, "minor": { "type": "boolean" } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "templateId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "template": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "organizationId" ], "additionalProperties": false }, "material": { "type": "boolean" } }, "required": [ "template", "material" ], "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}/forms/{templateId}/archive": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_templateid_archive", "summary": "Archive one of the organization's own forms", "tags": [ "Forms" ], "description": "Soft delete: open assessments keep their pinned questions, and a patch of status back to draft unarchives it", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": {} }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "templateId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "organizationId" ], "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}/forms/fork": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_fork", "summary": "Copy a catalog template into this organization", "tags": [ "Forms" ], "description": "Creates an editable form the organization owns, recording the catalog template and version it was taken from. Several copies of one template may coexist; give each a name.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "templateId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": [ "templateId" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "organizationId" ], "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}/forms/{templateId}/upstream-diff": { "get": { "operationId": "get_platform_v1_organizations_organizationid_forms_templateid_upstream_diff", "summary": "Show what the catalog template changed since this copy was taken", "tags": [ "Forms" ], "description": "Item-level diff marking which library changes can be applied and which conflict with the organization’s own edits", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "templateId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "templateId": { "type": "string" }, "templateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" }, "hasBase": { "type": "boolean" }, "items": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "change": { "type": "string", "enum": [ "added", "removed", "changed" ] }, "locallyModified": { "type": "boolean" }, "conflicting": { "type": "boolean" } }, "required": [ "itemId", "change", "locallyModified", "conflicting" ], "additionalProperties": false } }, "conflicts": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "change": { "type": "string", "enum": [ "added", "removed", "changed" ] }, "locallyModified": { "type": "boolean" }, "conflicting": { "type": "boolean" } }, "required": [ "itemId", "change", "locallyModified", "conflicting" ], "additionalProperties": false } }, "appliable": { "type": "array", "items": { "type": "object", "properties": { "itemId": { "type": "string" }, "change": { "type": "string", "enum": [ "added", "removed", "changed" ] }, "locallyModified": { "type": "boolean" }, "conflicting": { "type": "boolean" } }, "required": [ "itemId", "change", "locallyModified", "conflicting" ], "additionalProperties": false } } }, "required": [ "templateId", "templateVersion", "latestTemplateVersion", "updateAvailable", "hasBase", "items", "conflicts", "appliable" ], "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}/forms/{templateId}/adopt-update": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_templateid_adopt_update", "summary": "Adopt, replace or dismiss a catalog template update", "tags": [ "Forms" ], "description": "apply takes the non-conflicting library changes, replace overwrites the copy wholesale, dismiss keeps the copy and stops reporting this version", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "enum": [ "apply", "replace", "dismiss" ] } }, "required": [ "action" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "templateId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "name": { "type": "string" }, "slug": { "type": "string" }, "description": { "type": "string" }, "kind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "jurisdictions": { "type": "array", "items": { "type": "string" } }, "satisfiesObligations": { "type": "array", "items": { "type": "string" } }, "version": { "type": "number" }, "revision": { "type": "number" }, "status": { "type": "string", "enum": [ "active", "draft", "archived" ] }, "iconUrl": { "type": "string" }, "config": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "publishedConfig": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false }, "dateCreated": {}, "dateUpdated": {}, "organizationId": { "type": "string" }, "formTemplateId": { "type": "string" }, "formTemplateVersion": { "type": "number" }, "latestTemplateVersion": { "type": "number" }, "updateAvailable": { "type": "boolean" } }, "required": [ "id", "name", "slug", "version", "status", "config", "dateCreated", "dateUpdated", "organizationId" ], "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}/forms/submissions": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions", "summary": "Create a form submission", "tags": [ "Form Submissions" ], "description": "Creates a new draft form submission", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 200 }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "assigneeId": { "type": "string" }, "templateId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "submittedBy": { "type": "string", "minLength": 1 }, "dueAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "templateId", "submittedBy" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} }, "generatedDocumentId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "approvalState": { "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": {} } }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "answers", "status", "submittedBy", "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_platform_v1_organizations_organizationid_forms_submissions", "summary": "List form submissions", "tags": [ "Form Submissions" ], "description": "Lists form submissions for an organization", "parameters": [ { "schema": { "default": 0, "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "in": "query", "name": "offset", "required": false }, { "schema": { "default": 100, "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "query", "name": "templateId", "required": false }, { "schema": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "policy", "assessment" ] }, "in": "query", "name": "kind", "required": false }, { "schema": { "type": "string", "enum": [ "dateCreated", "status" ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "count": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} }, "generatedDocumentId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "approvalState": { "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": {} } }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "answers", "status", "submittedBy", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total", "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}/forms/submissions/{submissionId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_forms_submissions_submissionid", "summary": "Get a form submission", "tags": [ "Form Submissions" ], "description": "Gets a single form submission by ID", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} }, "generatedDocumentId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "approvalState": { "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": {} } }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": {}, "additionalProperties": {} } }, "templateSnapshot": { "type": "object", "properties": { "type": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "children": { "type": "object", "properties": { "condition": { "anyOf": [ { "type": "string" }, { "type": "boolean" } ] }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "type": { "type": "string", "enum": [ "text", "textarea", "select", "radio", "checkbox", "checkboxGroup", "switch", "date", "number", "file", "entityMulti", "riskMatrix", "likelihoodSeverity", "riskRegister", "signature", "sectionHeader", "sectionHeaderDivider" ] }, "label": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "placeholder": { "type": "string" }, "options": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "disabled": { "type": "boolean" } }, "required": [ "value", "label" ], "additionalProperties": false } }, "defaultValue": { "anyOf": [ { "type": "string" }, { "type": "boolean" }, { "type": "array", "items": { "type": "string" } } ] }, "validationRules": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "string", "boolean", "array", "date", "number", "riskScore", "signature" ] }, "required": { "type": "boolean" }, "min": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "max": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "pattern": { "type": "string" } }, "required": [ "type" ], "additionalProperties": false }, "componentId": { "type": "string" }, "entityKind": { "type": "string", "enum": [ "control", "dataSystem", "framework", "document", "vendor", "processingActivity", "dataCategory", "dataSubject", "risk", "project" ] }, "checkedChildren": { "type": "string" }, "uncheckedChildren": { "type": "string" }, "sectionId": { "type": "string" }, "visibleIf": { "$ref": "#/components/schemas/__schema0" }, "prefillFrom": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "id", "type", "order" ], "additionalProperties": false } } }, "required": [ "condition" ], "additionalProperties": false } }, "required": [ "id", "type", "order" ], "additionalProperties": false } }, "sections": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "order": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "visibleIf": { "$ref": "#/components/schemas/__schema0" } }, "required": [ "id", "title", "order" ], "additionalProperties": false } }, "customValidation": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "outputTemplate": { "type": "array", "items": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "lookups": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } } }, "defaults": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "recommendedControlKeys": { "type": "array", "items": { "type": "string" } }, "frameworkScope": { "type": "array", "items": { "type": "string" } }, "riskRules": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "title": { "type": "string" }, "when": { "$ref": "#/components/schemas/__schema0" }, "description": { "type": "string" }, "likelihood": { "type": "integer", "minimum": 1, "maximum": 5 }, "severity": { "type": "integer", "minimum": 1, "maximum": 5 }, "recommendation": { "type": "string" } }, "required": [ "id", "title", "when", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "type", "items" ], "additionalProperties": false } }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "answers", "status", "submittedBy", "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_platform_v1_organizations_organizationid_forms_submissions_submissionid", "summary": "Update a form submission", "tags": [ "Form Submissions" ], "description": "Updates a draft form submission 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": {} }, "required": [ "op", "path" ] } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "projectId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} }, "generatedDocumentId": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {}, "approvalState": { "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" } }, "required": [ "id" ], "additionalProperties": {} } }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": {}, "additionalProperties": {} } } }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "answers", "status", "submittedBy", "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}/forms/submissions/{submissionId}/submit": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_submit", "summary": "Submit a form submission", "tags": [ "Form Submissions" ], "description": "Submits a form and generates the document", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "submittedBy": { "type": "string", "minLength": 1 } }, "required": [ "submittedBy" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 5000 }, "type": { "type": "string", "enum": [ "policy", "statement", "faq", "link", "report", "export", "nda", "questionnaire" ] }, "accessLevel": { "type": "string", "enum": [ "public", "restricted", "internal" ] }, "requiredAgreementId": { "type": "string", "format": "uuid" }, "allowlistEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "allowlistDomains": { "type": "array", "items": { "type": "string" } }, "tags": { "type": "array", "items": { "type": "string" } }, "frameworks": { "type": "array", "items": { "type": "string" } }, "slug": { "type": "string", "maxLength": 256 }, "policyType": { "type": "string", "maxLength": 256 }, "policyTemplateVersion": { "type": "integer" }, "formSubmissionId": { "type": "string", "maxLength": 256 }, "migratedFromPolicyId": { "type": "string", "format": "uuid" }, "assets": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "html", "json", "pdf", "markdown", "txt", "csv", "doc", "docx", "xls", "xlsm", "xlsx", "zip" ] }, "language": { "type": "string" }, "body": { "type": "string" }, "file": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "size": { "type": "integer" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "etag": { "type": "string" }, "sha256": { "type": "string" } }, "required": [ "bucket", "key", "size" ], "additionalProperties": false }, "version": { "type": "integer" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "format", "version", "dateCreated", "dateUpdated" ], "additionalProperties": false } }, "question": { "type": "string", "maxLength": 5000 }, "url": { "type": "string", "format": "uri" }, "version": { "type": "integer" }, "publishedReleaseId": { "oneOf": [ { "type": "string" } ] }, "hasUnpublishedChanges": { "type": "boolean" }, "templateUpdateAvailable": { "type": "boolean" }, "status": { "type": "string", "enum": [ "active", "archived" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "name", "type", "accessLevel", "assets", "version", "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" ] } } } } } } }, "/organizations/{organizationId}/sso/domains": { "get": { "operationId": "get_platform_v1_organizations_organizationid_sso_domains", "summary": "List SSO email domains", "tags": [ "SSO" ], "description": "Lists the verified and pending SSO email domains.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "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", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "domain": { "type": "string" }, "txtRecordHost": { "type": "string" }, "txtToken": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "verifiedAt": { "anyOf": [ {}, { "type": "string" } ] } }, "required": [ "id", "domain", "txtRecordHost", "txtToken", "status" ], "additionalProperties": false } } }, "required": [ "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" ] } } } } } }, "post": { "operationId": "post_platform_v1_organizations_organizationid_sso_domains", "summary": "Add an SSO email domain", "tags": [ "SSO" ], "description": "Registers an email domain for DNS TXT verification before it can be used for SSO.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "pattern": "^(?=.{1,253}$)([a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\\.)+[a-z]{2,}$" } }, "required": [ "domain" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "domain": { "type": "string" }, "txtRecordHost": { "type": "string" }, "txtToken": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "verifiedAt": { "anyOf": [ {}, { "type": "string" } ] } }, "required": [ "id", "domain", "txtRecordHost", "txtToken", "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}/sso/domains/{domainId}": { "delete": { "operationId": "delete_platform_v1_organizations_organizationid_sso_domains_domainid", "summary": "Remove an SSO email domain", "tags": [ "SSO" ], "description": "Removes a verified or pending SSO email domain.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "domainId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "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}/sso/domains/{domainId}/verify": { "post": { "operationId": "post_platform_v1_organizations_organizationid_sso_domains_domainid_verify", "summary": "Verify an SSO email domain", "tags": [ "SSO" ], "description": "Checks the DNS TXT challenge for the domain and marks it verified on success.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "domainId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "domain": { "type": "string" }, "txtRecordHost": { "type": "string" }, "txtToken": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "verifiedAt": { "anyOf": [ {}, { "type": "string" } ] } }, "required": [ "id", "domain", "txtRecordHost", "txtToken", "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}/sso/connection": { "get": { "operationId": "get_platform_v1_organizations_organizationid_sso_connection", "summary": "Get the SSO connection", "tags": [ "SSO" ], "description": "Returns the organization SSO connection. The client secret is never returned.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "connection": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "type": { "type": "string", "enum": [ "oidc", "saml" ] }, "provider": { "type": "string", "enum": [ "okta", "entra", "google", "auth0", "ping", "generic-oidc", "generic-saml" ] }, "issuer": { "type": "string", "format": "uri" }, "clientId": { "type": "string" }, "samlMetadataUrl": { "type": "string", "format": "uri" }, "samlGroupsAttribute": { "type": "string" }, "defaultRole": { "type": "string", "enum": [ "admin", "limited" ] }, "status": { "type": "string", "enum": [ "draft", "testing", "active" ] }, "enforced": { "type": "boolean" }, "roleMapping": { "type": "object", "properties": { "claim": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "limited" ] }, "projectIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "value", "role" ], "additionalProperties": false } }, "onNoMatch": { "type": "string", "enum": [ "default", "deny" ] } }, "required": [ "claim", "rules", "onNoMatch" ], "additionalProperties": false }, "lastSeenClaims": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "values" ], "additionalProperties": false } }, "lastTest": { "type": "object", "properties": { "at": { "anyOf": [ {}, { "type": "string" } ] }, "outcome": { "type": "string", "enum": [ "success", "failed" ] }, "reason": { "type": "string" }, "warning": { "type": "string" }, "grants": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "limited" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "required": [ "at", "outcome" ], "additionalProperties": false }, "secretReadable": { "type": "boolean" } }, "required": [ "id", "type", "provider", "issuer", "defaultRole", "status", "enforced", "secretReadable" ], "additionalProperties": false }, { "type": "null" } ] }, "samlServiceProvider": { "anyOf": [ { "type": "object", "properties": { "acsUrl": { "type": "string", "format": "uri" }, "entityId": { "type": "string" } }, "required": [ "acsUrl", "entityId" ], "additionalProperties": false }, { "type": "null" } ] }, "breakGlassReady": { "type": "boolean" } }, "required": [ "connection", "samlServiceProvider", "breakGlassReady" ], "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_platform_v1_organizations_organizationid_sso_connection", "summary": "Create the SSO connection", "tags": [ "SSO" ], "description": "Creates the organization OIDC SSO connection in draft status.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "okta", "entra", "google", "auth0", "ping", "generic-oidc", "generic-saml" ] }, "issuer": { "type": "string", "format": "uri" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "samlMetadataUrl": { "type": "string", "format": "uri" }, "samlGroupsAttribute": { "type": "string", "maxLength": 256 }, "defaultRole": { "type": "string", "enum": [ "admin", "limited" ] }, "roleMapping": { "anyOf": [ { "type": "object", "properties": { "claim": { "type": "string", "maxLength": 256 }, "rules": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "admin", "limited" ] }, "projectIds": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "value", "role" ] } }, "onNoMatch": { "default": "default", "type": "string", "enum": [ "default", "deny" ] } }, "required": [ "claim", "rules" ] }, { "type": "null" } ] } }, "required": [ "provider", "issuer" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "type": { "type": "string", "enum": [ "oidc", "saml" ] }, "provider": { "type": "string", "enum": [ "okta", "entra", "google", "auth0", "ping", "generic-oidc", "generic-saml" ] }, "issuer": { "type": "string", "format": "uri" }, "clientId": { "type": "string" }, "samlMetadataUrl": { "type": "string", "format": "uri" }, "samlGroupsAttribute": { "type": "string" }, "defaultRole": { "type": "string", "enum": [ "admin", "limited" ] }, "status": { "type": "string", "enum": [ "draft", "testing", "active" ] }, "enforced": { "type": "boolean" }, "roleMapping": { "type": "object", "properties": { "claim": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "limited" ] }, "projectIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "value", "role" ], "additionalProperties": false } }, "onNoMatch": { "type": "string", "enum": [ "default", "deny" ] } }, "required": [ "claim", "rules", "onNoMatch" ], "additionalProperties": false }, "lastSeenClaims": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "values" ], "additionalProperties": false } }, "lastTest": { "type": "object", "properties": { "at": { "anyOf": [ {}, { "type": "string" } ] }, "outcome": { "type": "string", "enum": [ "success", "failed" ] }, "reason": { "type": "string" }, "warning": { "type": "string" }, "grants": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "limited" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "required": [ "at", "outcome" ], "additionalProperties": false }, "secretReadable": { "type": "boolean" } }, "required": [ "id", "type", "provider", "issuer", "defaultRole", "status", "enforced", "secretReadable" ], "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}/sso/connection/{connectionId}": { "patch": { "operationId": "patch_platform_v1_organizations_organizationid_sso_connection_connectionid", "summary": "Update the SSO connection", "tags": [ "SSO" ], "description": "Updates connection settings, lifecycle status, or enforcement. Enforcement requires an active connection and a verified domain.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "provider": { "type": "string", "enum": [ "okta", "entra", "google", "auth0", "ping", "generic-oidc", "generic-saml" ] }, "issuer": { "type": "string", "format": "uri" }, "clientId": { "type": "string" }, "clientSecret": { "type": "string" }, "samlMetadataUrl": { "type": "string", "format": "uri" }, "samlGroupsAttribute": { "type": "string", "maxLength": 256 }, "defaultRole": { "type": "string", "enum": [ "admin", "limited" ] }, "roleMapping": { "anyOf": [ { "type": "object", "properties": { "claim": { "type": "string", "maxLength": 256 }, "rules": { "minItems": 1, "maxItems": 50, "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "admin", "limited" ] }, "projectIds": { "minItems": 1, "type": "array", "items": { "type": "string" } } }, "required": [ "value", "role" ] } }, "onNoMatch": { "default": "default", "type": "string", "enum": [ "default", "deny" ] } }, "required": [ "claim", "rules" ] }, { "type": "null" } ] }, "status": { "type": "string", "enum": [ "draft", "testing", "active" ] }, "enforced": { "type": "boolean" } } } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "type": { "type": "string", "enum": [ "oidc", "saml" ] }, "provider": { "type": "string", "enum": [ "okta", "entra", "google", "auth0", "ping", "generic-oidc", "generic-saml" ] }, "issuer": { "type": "string", "format": "uri" }, "clientId": { "type": "string" }, "samlMetadataUrl": { "type": "string", "format": "uri" }, "samlGroupsAttribute": { "type": "string" }, "defaultRole": { "type": "string", "enum": [ "admin", "limited" ] }, "status": { "type": "string", "enum": [ "draft", "testing", "active" ] }, "enforced": { "type": "boolean" }, "roleMapping": { "type": "object", "properties": { "claim": { "type": "string" }, "rules": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "limited" ] }, "projectIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "value", "role" ], "additionalProperties": false } }, "onNoMatch": { "type": "string", "enum": [ "default", "deny" ] } }, "required": [ "claim", "rules", "onNoMatch" ], "additionalProperties": false }, "lastSeenClaims": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "values": { "type": "array", "items": { "type": "string" } } }, "required": [ "name", "values" ], "additionalProperties": false } }, "lastTest": { "type": "object", "properties": { "at": { "anyOf": [ {}, { "type": "string" } ] }, "outcome": { "type": "string", "enum": [ "success", "failed" ] }, "reason": { "type": "string" }, "warning": { "type": "string" }, "grants": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string" }, "role": { "type": "string", "enum": [ "admin", "limited" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "required": [ "at", "outcome" ], "additionalProperties": false }, "secretReadable": { "type": "boolean" } }, "required": [ "id", "type", "provider", "issuer", "defaultRole", "status", "enforced", "secretReadable" ], "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_platform_v1_organizations_organizationid_sso_connection_connectionid", "summary": "Delete the SSO connection", "tags": [ "SSO" ], "description": "Deletes a non-enforced SSO connection.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "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}/sso/connection/{connectionId}/test": { "post": { "operationId": "post_platform_v1_organizations_organizationid_sso_connection_connectionid_test", "summary": "Start a test SSO sign-in", "tags": [ "SSO" ], "description": "Returns an identity provider authorization URL that validates the connection and records the claims it returns. A test sign-in never creates an account or a session.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "redirectUrl": { "type": "string", "format": "uri" } }, "required": [ "redirectUrl" ], "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" ] } } } } } } }, "/sso/start": { "post": { "operationId": "post_platform_v1_sso_start", "summary": "Start an SSO login", "tags": [ "SSO" ], "description": "Returns the identity provider authorization URL when SSO is configured, otherwise a successful not-configured result.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "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,}$" }, "organizationSlug": { "type": "string", "maxLength": 100 } } } } } }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "configured": { "type": "boolean", "enum": [ false ] } }, "required": [ "configured" ], "additionalProperties": false }, { "type": "object", "properties": { "redirectUrl": { "type": "string", "format": "uri" }, "transactionSecret": { "type": "string" } }, "required": [ "redirectUrl", "transactionSecret" ], "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" ] } } } } } } }, "/sso/callback": { "get": { "operationId": "get_platform_v1_sso_callback", "summary": "SSO callback", "tags": [ "SSO" ], "description": "Completes the OIDC authorization-code flow and redirects the browser back to the sign-in page.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "code", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "state", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "error", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "error_description", "required": false } ], "responses": { "302": { "description": "Default Response", "content": { "application/json": { "schema": {} } } }, "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" ] } } } } } } }, "/sso/saml/callback": { "get": { "operationId": "get_platform_v1_sso_saml_callback", "summary": "SAML federation callback", "tags": [ "SSO" ], "description": "Completes a Cognito SAML federation and redirects the browser back to the sign-in page.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "code", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "state", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "error", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "error_description", "required": false } ], "responses": { "302": { "description": "Default Response", "content": { "application/json": { "schema": {} } } }, "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" ] } } } } } } }, "/sso/token": { "post": { "operationId": "post_platform_v1_sso_token", "summary": "Exchange an SSO sign-in code for tokens", "tags": [ "SSO" ], "description": "Exchanges the one-time code from the SSO callback redirect for Cognito tokens.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "browserBinding": { "type": "string" } }, "required": [ "code", "browserBinding" ] } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "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" ] } } } } } } }, "/sso/grant/verify": { "post": { "operationId": "post_platform_v1_sso_grant_verify", "summary": "Verify and consume an SSO login grant", "tags": [ "SSO" ], "description": "Used by the Cognito custom-auth verify trigger to validate the SSO grant challenge answer.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "grant": { "type": "string" }, "accountId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$" }, "browserBinding": { "type": "string" } }, "required": [ "grant", "accountId" ] } } }, "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" ] } } } } } } }, "/sso/link": { "post": { "operationId": "post_platform_v1_sso_link", "summary": "Link SSO to an existing account", "tags": [ "SSO" ], "description": "Proves ownership of an existing password account and links the pending SSO identity to it.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "password": { "type": "string" }, "mfaCode": { "type": "string", "maxLength": 10 }, "session": { "type": "string" } }, "required": [ "code", "password" ] } } }, "required": true }, "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": {}, "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}/forms/submissions/{submissionId}/request-review": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_request_review", "summary": "Send an assessment for review", "tags": [ "Assessments" ], "description": "Hands a draft to reviewers and moves it into review.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reviewerIds": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "dueAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "reviewerIds" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/decide-review": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_decide_review", "summary": "Request changes on or reject an assessment", "tags": [ "Assessments" ], "description": "Approval is a separate endpoint, since only approval mints a record and starts the clocks.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "decision": { "type": "string", "enum": [ "requestChanges", "reject" ] }, "comment": { "type": "string", "maxLength": 5000 } }, "required": [ "decision" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/approve": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_approve", "summary": "Approve an assessment", "tags": [ "Assessments" ], "description": "Mints a document release as the immutable record and starts the review and retention clocks.", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "comment": { "type": "string", "maxLength": 5000 }, "reviewCadenceMonths": { "type": "integer", "minimum": 1, "maximum": 120 } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/reopen": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_reopen", "summary": "Reopen an assessment after a material change", "tags": [ "Assessments" ], "description": "Moves a decided assessment back to draft with a 45-day due date. The prior approval survives as its release.", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "reason": { "type": "string", "maxLength": 5000 } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/withdraw": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_withdraw", "summary": "Withdraw an assessment from review", "tags": [ "Assessments" ], "description": "Moves an assessment in review back to draft and clears its reviewers, so a review nobody can decide is never stuck.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/findings": { "put": { "operationId": "put_platform_v1_organizations_organizationid_forms_submissions_submissionid_findings", "summary": "Replace an assessment’s risk findings", "tags": [ "Assessments" ], "description": "Findings are edited as a set, so reordering and deletion need no endpoint of their own.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "findings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ] } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ] } }, "baseFindingIds": { "type": "array", "items": { "type": "string" } } }, "required": [ "findings" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/prefill": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_prefill", "summary": "Fill an assessment from the processing inventory", "tags": [ "Assessments" ], "description": "Writes what the inventory already knows, marking each answer as derived so nothing is prefilled silently.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "overwriteExisting": { "type": "boolean" } }, "required": [ "primaryRecordType", "primaryRecordId" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/produce": { "get": { "operationId": "get_platform_v1_organizations_organizationid_forms_submissions_submissionid_produce", "summary": "Reproduce an approved assessment as it was approved", "tags": [ "Assessments" ], "description": "Reads the questions frozen onto the assessment and the release minted when it was approved, so a regulator request is answered with what was actually approved rather than with the template as it stands today.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "submissionId": { "type": "string" }, "approvedAt": { "type": "string" }, "approvedBy": { "type": "string" }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "exactReproduction": { "type": "boolean" }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "answers": { "type": "object", "properties": {}, "additionalProperties": {} }, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "approvedDocument": { "type": "object", "properties": { "releaseId": { "type": "string" }, "version": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "additionalProperties": false } }, "required": [ "submissionId", "exactReproduction", "config", "answers", "riskFindings", "satisfiedObligations" ], "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}/assessments/attestation-summary": { "post": { "operationId": "post_platform_v1_organizations_organizationid_assessments_attestation_summary", "summary": "Build the annual assessment attestation summary", "tags": [ "Assessments" ], "description": "Everything CPPA regulation section 7157(b) makes a business submit for a reporting period. The assessments themselves are never included; a regulator asks for those separately and gets 30 days.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "periodStart": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "periodEnd": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "contactName": { "type": "string", "minLength": 1 }, "contactPhone": { "type": "string", "minLength": 1 }, "contactEmail": { "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,}$" }, "submitterName": { "type": "string", "minLength": 1 }, "submitterTitle": { "type": "string", "minLength": 1 }, "certifiedAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "periodStart", "periodEnd", "contactName", "contactPhone", "contactEmail", "submitterName", "submitterTitle", "certifiedAt" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "businessName": { "type": "string" }, "contactName": { "type": "string" }, "contactPhone": { "type": "string" }, "contactEmail": { "type": "string" }, "periodStart": { "type": "string" }, "periodEnd": { "type": "string" }, "assessmentCount": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "countsByProcessingActivity": { "type": "array", "items": { "type": "object", "properties": { "value": { "type": "string" }, "label": { "type": "string" }, "count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 } }, "required": [ "value", "label", "count" ], "additionalProperties": false } }, "personalInformationCategories": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "covered": { "type": "boolean" } }, "required": [ "code", "label", "covered" ], "additionalProperties": false } }, "sensitiveInformationCategories": { "type": "array", "items": { "type": "object", "properties": { "code": { "type": "string" }, "label": { "type": "string" }, "covered": { "type": "boolean" } }, "required": [ "code", "label", "covered" ], "additionalProperties": false } }, "attestation": { "type": "string" }, "submitterName": { "type": "string" }, "submitterTitle": { "type": "string" }, "certifiedAt": { "type": "string" } }, "required": [ "businessName", "contactName", "contactPhone", "contactEmail", "periodStart", "periodEnd", "assessmentCount", "countsByProcessingActivity", "personalInformationCategories", "sensitiveInformationCategories", "attestation", "submitterName", "submitterTitle", "certifiedAt" ], "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}/assessment-links": { "get": { "operationId": "get_platform_v1_organizations_organizationid_assessment_links", "summary": "List what assessments touch", "tags": [ "Assessments" ], "description": "Filter by submission for one assessment’s links, or by entity for every assessment touching that record.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "query", "name": "submissionId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "entityKind", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "entityId", "required": false }, { "schema": { "type": "string", "enum": [ "accepted", "pending", "rejected" ] }, "in": "query", "name": "state", "required": false }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "total": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "submissionId": { "type": "string" }, "entityKind": { "type": "string" }, "entityId": { "type": "string" }, "fieldId": { "type": "string" }, "source": { "type": "string", "enum": [ "manual", "prefill", "ai_suggested", "ai_accepted" ] }, "state": { "type": "string", "enum": [ "accepted", "pending", "rejected" ] }, "rationale": { "type": "string", "maxLength": 2000 }, "confidence": { "type": "number", "minimum": 0, "maximum": 1 }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "submissionId", "entityKind", "entityId", "source", "state", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "total", "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}/forms/submissions/{submissionId}/shares": { "post": { "operationId": "post_platform_v1_organizations_organizationid_forms_submissions_submissionid_shares", "summary": "Share part of an assessment with an outside guest", "tags": [ "Assessments" ], "description": "Grants a section or the whole assessment to a guest, who signs in with an emailed passcode to answer it. Someone new to the organization gets a guest invite; an existing guest gets an email linking to the share.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "targetType": { "type": "string", "enum": [ "section", "all" ] }, "targetId": { "type": "string" }, "email": { "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,}$" } }, "required": [ "targetType", "email" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "submissionId": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "all" ] }, "targetId": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "opened", "submitted", "revoked" ] }, "invitedAt": {}, "openedAt": {}, "submittedAt": {}, "lastAccessAt": {}, "expiresAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "submissionId", "targetType", "email", "status", "expiresAt", "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_platform_v1_organizations_organizationid_forms_submissions_submissionid_shares", "summary": "List a submission’s external shares", "tags": [ "Assessments" ], "description": "The owner’s view of who an assessment has been shared with. Never returns tokens.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "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" }, "submissionId": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "all" ] }, "targetId": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "opened", "submitted", "revoked" ] }, "invitedAt": {}, "openedAt": {}, "submittedAt": {}, "lastAccessAt": {}, "expiresAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "submissionId", "targetType", "email", "status", "expiresAt", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "required": [ "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}/forms/submissions/{submissionId}/shares/{formShareId}": { "delete": { "operationId": "delete_platform_v1_organizations_organizationid_forms_submissions_submissionid_shares_formshareid", "summary": "Revoke a share and every live session under it", "tags": [ "Assessments" ], "description": "Kills the invite link and any open respondent session.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "formShareId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "submissionId": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "all" ] }, "targetId": { "type": "string" }, "email": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "opened", "submitted", "revoked" ] }, "invitedAt": {}, "openedAt": {}, "submittedAt": {}, "lastAccessAt": {}, "expiresAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "submissionId", "targetType", "email", "status", "expiresAt", "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" ] } } } } } } }, "/guest/{organizationId}/form-shares": { "get": { "operationId": "get_platform_v1_guest_organizationid_form_shares", "summary": "List the assessment shares granted to the signed-in guest", "tags": [ "Assessments" ], "description": "Returns only shares granted to the caller’s guest membership that are neither withdrawn nor expired.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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" }, "submissionId": { "type": "string" }, "templateName": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "all" ] }, "targetId": { "type": "string" }, "sectionTitle": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "opened", "submitted", "revoked" ] }, "invitedAt": {}, "expiresAt": {} }, "required": [ "id", "submissionId", "templateName", "targetType", "status", "expiresAt" ], "additionalProperties": false } } }, "required": [ "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" ] } } } } } } }, "/guest/{organizationId}/form-shares/{formShareId}": { "get": { "operationId": "get_platform_v1_guest_organizationid_form_shares_formshareid", "summary": "Read the part of an assessment shared with the signed-in guest", "tags": [ "Assessments" ], "description": "Returns only the shared section, or the whole assessment for a whole-assessment share, with its answers.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "formShareId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "submissionId": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "all" ] }, "targetId": { "type": "string" }, "status": { "type": "string", "enum": [ "invited", "opened", "submitted", "revoked" ] }, "templateName": { "type": "string" }, "config": { "type": "object", "properties": {}, "additionalProperties": {} }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "editable": { "type": "boolean" }, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "submissionId", "targetType", "status", "templateName", "config", "answers", "editable" ], "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" ] } } } } } } }, "/guest/{organizationId}/form-shares/{formShareId}/answers": { "patch": { "operationId": "patch_platform_v1_guest_organizationid_form_shares_formshareid_answers", "summary": "Save answers inside the guest’s shared part", "tags": [ "Assessments" ], "description": "Writes only fields inside the share’s target; a field outside it fails the whole request.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "answers": { "type": "object", "propertyNames": { "type": "string", "maxLength": 256 }, "additionalProperties": {} } }, "required": [ "answers" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "formShareId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "saved": { "type": "array", "items": { "type": "string" } } }, "required": [ "saved" ], "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" ] } } } } } } }, "/guest/{organizationId}/form-shares/{formShareId}/risk-findings": { "patch": { "operationId": "patch_platform_v1_guest_organizationid_form_shares_formshareid_risk_findings", "summary": "Replace the risks a whole-assessment guest contributed", "tags": [ "Assessments" ], "description": "Replaces only the findings this share contributed; refused for a section share.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "findings": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] } }, "required": [ "id", "description", "likelihood", "severity" ] } } }, "required": [ "findings" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "formShareId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } } }, "required": [ "riskFindings" ], "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" ] } } } } } } }, "/guest/{organizationId}/form-shares/{formShareId}/submit": { "post": { "operationId": "post_platform_v1_guest_organizationid_form_shares_formshareid_submit", "summary": "Mark the guest’s shared part done", "tags": [ "Assessments" ], "description": "Marks this share submitted. The assessment itself stays with its owner to submit.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "formShareId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "invited", "opened", "submitted", "revoked" ] } }, "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}/forms/submissions/{submissionId}/assignments": { "put": { "operationId": "put_platform_v1_organizations_organizationid_forms_submissions_submissionid_assignments", "summary": "Assign a section, a question, or the whole assessment", "tags": [ "Assessments" ], "description": "Delegates a part of an assessment to a person. Re-assigning by id keeps the assignee’s status and timestamps.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assignment": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string", "minLength": 1 }, "dueAt": { "anyOf": [ { "type": "string" }, {} ] } }, "required": [ "targetType", "assigneeId" ] } }, "required": [ "assignment" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/{submissionId}/assignments/{assignmentId}": { "delete": { "operationId": "delete_platform_v1_organizations_organizationid_forms_submissions_submissionid_assignments_assignmentid", "summary": "Remove an assignment", "tags": [ "Assessments" ], "description": "Idempotent: an id that is not present leaves the set unchanged.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "path", "name": "submissionId", "required": true }, { "schema": { "type": "string", "minLength": 1 }, "in": "path", "name": "assignmentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "templateId": { "type": "string" }, "templateSource": { "default": "global", "type": "string", "enum": [ "global", "org" ] }, "templateKind": { "type": "string", "enum": [ "policy", "pia", "dpia", "ccpa_risk", "state_dpa", "tia", "lia", "fria", "ai_risk", "custom" ] }, "templateVersion": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "name": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "submitted", "processed" ] }, "approvalState": { "default": "draft", "type": "string", "enum": [ "draft", "in_review", "changes_requested", "approved", "rejected" ] }, "primaryRecordType": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "primaryRecordId": { "type": "string" }, "relatedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "assigneeId": { "type": "string" }, "reviewerIds": { "type": "array", "items": { "type": "string" } }, "assignments": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "targetType": { "type": "string", "enum": [ "section", "question", "all" ] }, "targetId": { "type": "string" }, "assigneeId": { "type": "string" }, "dueAt": {} }, "required": [ "id", "targetType", "assigneeId" ], "additionalProperties": false } }, "dueAt": {}, "approvedBy": { "type": "string" }, "approvedAt": {}, "approvedReleaseId": { "type": "string" }, "nextReviewDueAt": {}, "reviewCadenceMonths": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "materialChangeReopenedAt": {}, "retainUntil": {}, "riskFindings": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string", "maxLength": 5000 }, "likelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "severity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "mitigation": { "type": "string", "maxLength": 5000 }, "residualLikelihood": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "residualSeverity": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] }, { "type": "number", "enum": [ 3 ] }, { "type": "number", "enum": [ 4 ] }, { "type": "number", "enum": [ 5 ] } ] }, "ownerId": { "type": "string" }, "riskId": { "type": "string" }, "ruleId": { "type": "string" }, "riskTemplateId": { "type": "string" }, "affectedRecords": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "dataSystem", "processingActivity", "vendor" ] }, "id": { "type": "string" } }, "required": [ "type", "id" ], "additionalProperties": false } }, "contributedByShareId": { "type": "string" } }, "required": [ "id", "description", "likelihood", "severity" ], "additionalProperties": false } }, "satisfiedObligations": { "type": "array", "items": { "type": "string" } }, "answerMeta": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "origin": { "type": "string", "enum": [ "user", "prefill", "ai_draft" ] }, "sourceRef": { "type": "string" } }, "required": [ "origin" ], "additionalProperties": false } }, "answers": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "projectId": {}, "generatedDocumentId": { "type": "string" }, "reviewComments": { "type": "array", "items": { "type": "object", "properties": { "comment": { "type": "string" }, "decision": { "type": "string", "enum": [ "requestChanges", "reject", "reopen" ] }, "decidedBy": { "type": "string" }, "decidedAt": {} }, "required": [ "comment", "decision", "decidedBy", "decidedAt" ], "additionalProperties": false } }, "submittedBy": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "templateId", "templateSource", "templateVersion", "status", "approvalState", "submittedBy", "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}/forms/submissions/export": { "get": { "operationId": "get_platform_v1_organizations_organizationid_forms_submissions_export", "summary": "Export the responses to a template as CSV", "tags": [ "Form Submissions" ], "description": "One row per assessment started from the template, with the record fields followed by one column per question. Values that look like spreadsheet formulas are kept as text.", "parameters": [ { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "in": "query", "name": "templateId", "required": true }, { "schema": { "type": "string", "enum": [ "global", "org" ] }, "in": "query", "name": "templateSource", "required": false }, { "schema": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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}/actions": { "get": { "operationId": "get_platform_v1_organizations_organizationid_actions", "tags": [ "Actions" ], "description": "Lists the organization's configured actions.", "parameters": [ { "schema": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "in": "query", "name": "actionKey", "required": false }, { "schema": { "type": "string", "enum": [ "draft", "ready" ] }, "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" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "actionKey": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "status": { "type": "string", "enum": [ "draft", "ready" ] }, "enabled": { "type": "boolean" }, "scope": { "type": "string", "enum": [ "org", "project" ] }, "projectIds": { "type": "array", "items": { "type": "string" } }, "schedule": { "anyOf": [ {}, { "type": "null" } ] }, "options": {}, "scanConfigId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trigger": { "anyOf": [ { "type": "object", "properties": { "event": { "type": "string", "minLength": 1, "maxLength": 120 }, "filter": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "event" ], "additionalProperties": false }, { "type": "null" } ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] }, "sourceId": { "type": "string", "minLength": 1 } }, "required": [ "sourceType", "sourceId" ], "additionalProperties": false } }, "destinations": { "type": "array", "items": {} }, "agentOverrides": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } }, { "type": "null" } ] }, "origin": { "type": "string", "enum": [ "user", "system" ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "triggerScheduleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateCreated": {}, "dateUpdated": {}, "paused": { "type": "boolean" }, "lastRunAt": {}, "latestRunStatus": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "latestRunId": { "type": "string" }, "latestRunError": { "type": "string" } }, "required": [ "id", "organizationId", "name", "actionKey", "status", "enabled", "scope", "projectIds" ], "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" ] } } } } } }, "post": { "operationId": "post_platform_v1_organizations_organizationid_actions", "tags": [ "Actions" ], "description": "Creates an action.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "actionKey": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "scope": { "type": "string", "enum": [ "org", "project" ] }, "projectIds": { "maxItems": 100, "type": "array", "items": { "type": "string" } }, "schedule": { "anyOf": [ {}, { "type": "null" } ] }, "options": {}, "trigger": { "anyOf": [ { "type": "object", "properties": { "event": { "type": "string", "minLength": 1, "maxLength": 120 }, "filter": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "event" ] }, { "type": "null" } ] }, "inputs": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] }, "sourceId": { "type": "string", "minLength": 1 } }, "required": [ "sourceType", "sourceId" ] } }, "destinations": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "task", "notification", "email", "slack", "webhook", "evidence", "action" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type" ] } }, "agentOverrides": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } }, "required": [ "actionKey" ] } } }, "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" }, "name": { "type": "string" }, "actionKey": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "status": { "type": "string", "enum": [ "draft", "ready" ] }, "enabled": { "type": "boolean" }, "scope": { "type": "string", "enum": [ "org", "project" ] }, "projectIds": { "type": "array", "items": { "type": "string" } }, "schedule": { "anyOf": [ {}, { "type": "null" } ] }, "options": {}, "scanConfigId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trigger": { "anyOf": [ { "type": "object", "properties": { "event": { "type": "string", "minLength": 1, "maxLength": 120 }, "filter": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "event" ], "additionalProperties": false }, { "type": "null" } ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] }, "sourceId": { "type": "string", "minLength": 1 } }, "required": [ "sourceType", "sourceId" ], "additionalProperties": false } }, "destinations": { "type": "array", "items": {} }, "agentOverrides": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } }, { "type": "null" } ] }, "origin": { "type": "string", "enum": [ "user", "system" ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "triggerScheduleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateCreated": {}, "dateUpdated": {}, "paused": { "type": "boolean" }, "lastRunAt": {}, "latestRunStatus": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "latestRunId": { "type": "string" }, "latestRunError": { "type": "string" } }, "required": [ "id", "organizationId", "name", "actionKey", "status", "enabled", "scope", "projectIds" ], "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}/global-actions": { "get": { "operationId": "get_platform_v1_organizations_organizationid_global_actions", "tags": [ "Actions" ], "description": "Lists the available action types and their billing costs.", "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": { "key": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "label": { "type": "string" }, "automations": { "type": "array", "items": { "type": "string", "enum": [ "schedule", "trigger" ] } }, "manualRun": { "type": "string", "enum": [ "config", "none", "form" ] }, "requiresConfig": { "type": "boolean" }, "actions": { "type": "number" }, "dataCredits": { "type": "number" }, "agents": { "type": "array", "items": { "type": "object", "properties": { "agentId": { "type": "string", "minLength": 1 }, "required": { "type": "boolean" } }, "required": [ "agentId", "required" ], "additionalProperties": false } }, "tools": { "type": "array", "items": { "type": "string" } }, "acceptedInputs": { "type": "array", "items": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] } }, "acceptedDestinations": { "type": "array", "items": { "type": "string", "enum": [ "task", "notification", "email", "slack", "webhook", "evidence", "action" ] } }, "trigger": { "type": "object", "properties": { "events": { "type": "array", "items": { "type": "string" } } }, "required": [ "events" ], "additionalProperties": false }, "leaf": { "type": "boolean" }, "origin": { "type": "string", "enum": [ "user", "system" ] } }, "required": [ "key", "label", "automations", "manualRun", "requiresConfig", "actions", "dataCredits" ], "additionalProperties": {} } } }, "required": [ "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}/actions/{actionId}": { "put": { "operationId": "put_platform_v1_organizations_organizationid_actions_actionid", "tags": [ "Actions" ], "description": "Updates an action.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 160 }, "enabled": { "type": "boolean" }, "projectIds": { "maxItems": 100, "type": "array", "items": { "type": "string" } }, "schedule": { "anyOf": [ {}, { "type": "null" } ] }, "options": {}, "trigger": { "anyOf": [ { "type": "object", "properties": { "event": { "type": "string", "minLength": 1, "maxLength": 120 }, "filter": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "event" ] }, { "type": "null" } ] }, "inputs": { "maxItems": 100, "type": "array", "items": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] }, "sourceId": { "type": "string", "minLength": 1 } }, "required": [ "sourceType", "sourceId" ] } }, "destinations": { "maxItems": 20, "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "task", "notification", "email", "slack", "webhook", "evidence", "action" ] }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "type" ] } }, "agentOverrides": { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ] } } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "actionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "name": { "type": "string" }, "actionKey": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "status": { "type": "string", "enum": [ "draft", "ready" ] }, "enabled": { "type": "boolean" }, "scope": { "type": "string", "enum": [ "org", "project" ] }, "projectIds": { "type": "array", "items": { "type": "string" } }, "schedule": { "anyOf": [ {}, { "type": "null" } ] }, "options": {}, "scanConfigId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "trigger": { "anyOf": [ { "type": "object", "properties": { "event": { "type": "string", "minLength": 1, "maxLength": 120 }, "filter": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "event" ], "additionalProperties": false }, { "type": "null" } ] }, "inputs": { "type": "array", "items": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] }, "sourceId": { "type": "string", "minLength": 1 } }, "required": [ "sourceType", "sourceId" ], "additionalProperties": false } }, "destinations": { "type": "array", "items": {} }, "agentOverrides": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string", "minLength": 1 }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" } }, "required": [ "enabled" ], "additionalProperties": false } }, { "type": "null" } ] }, "origin": { "type": "string", "enum": [ "user", "system" ] }, "connectionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "triggerScheduleId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "createdBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "dateCreated": {}, "dateUpdated": {}, "paused": { "type": "boolean" }, "lastRunAt": {}, "latestRunStatus": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "latestRunId": { "type": "string" }, "latestRunError": { "type": "string" } }, "required": [ "id", "organizationId", "name", "actionKey", "status", "enabled", "scope", "projectIds" ], "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_platform_v1_organizations_organizationid_actions_actionid", "tags": [ "Actions" ], "description": "Deletes an action.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "actionId", "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}/actions/{actionId}/run": { "post": { "operationId": "post_platform_v1_organizations_organizationid_actions_actionid_run", "tags": [ "Actions" ], "description": "Triggers a run of an action.", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "input": { "type": "object", "properties": { "sourceType": { "type": "string", "enum": [ "project", "dataSystem", "control", "connection" ] }, "sourceId": { "type": "string" }, "payload": {} } } } }, { "type": "null" } ] } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "actionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "started": { "type": "boolean" }, "runId": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "summary": {} }, "required": [ "started" ], "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}/action-runs": { "get": { "operationId": "get_platform_v1_organizations_organizationid_action_runs", "tags": [ "Actions" ], "description": "Lists action runs for the organization.", "parameters": [ { "schema": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "in": "query", "name": "actionKey", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "projectId", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "hasConnection", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "cursor", "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": { "runId": { "type": "string" }, "actionKey": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "actionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "projectId": { "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jurisdictionCode": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "triggerSource": { "type": "string", "enum": [ "manual", "schedule", "system" ] }, "startedAt": {}, "completedAt": {}, "durationMs": { "type": "number" }, "connectionId": { "type": "string" }, "integrationKey": { "type": "string" }, "action": { "type": "string" }, "archetype": { "type": "string" }, "details": {}, "dispatched": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "string" } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "runId", "actionKey", "projectId", "status", "triggerSource", "startedAt" ], "additionalProperties": {} } }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "required": [ "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}/action-runs/{runId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_action_runs_runid", "tags": [ "Actions" ], "description": "Gets a single action run.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "runId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "runId": { "type": "string" }, "actionKey": { "type": "string", "enum": [ "compliance.scan", "tracker.scan", "gcm.scan", "dsar.fanout", "evidence.monitor", "integration.check" ] }, "actionId": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "projectId": { "type": "string" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "jurisdictionCode": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "triggerSource": { "type": "string", "enum": [ "manual", "schedule", "system" ] }, "startedAt": {}, "completedAt": {}, "durationMs": { "type": "number" }, "connectionId": { "type": "string" }, "integrationKey": { "type": "string" }, "action": { "type": "string" }, "archetype": { "type": "string" }, "details": {}, "dispatched": { "type": "object", "properties": { "groups": { "type": "array", "items": { "type": "string" } } }, "required": [ "groups" ], "additionalProperties": false } }, "required": [ "runId", "actionKey", "projectId", "status", "triggerSource", "startedAt" ], "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}/integrations": { "get": { "operationId": "get_platform_v1_organizations_organizationid_integrations", "tags": [ "Integrations" ], "description": "Lists the integrations this organization can connect.", "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": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "featureGate": { "type": "string" }, "credentialFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "secret", "number", "boolean", "select", "list", "multiselect" ] }, "required": { "type": "boolean" }, "immutable": { "type": "boolean" }, "lockedAfterConnect": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ], "additionalProperties": false } }, "placeholder": { "type": "string" }, "default": { "type": "string" }, "help": { "type": "string" }, "advanced": { "type": "boolean" }, "showWhen": { "type": "object", "properties": { "field": { "type": "string" }, "equals": { "type": "array", "items": { "type": "string" } } }, "required": [ "field", "equals" ], "additionalProperties": false } }, "required": [ "key", "label", "type" ], "additionalProperties": false } }, "connectionFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "secret", "number", "boolean", "select", "list", "multiselect" ] }, "required": { "type": "boolean" }, "immutable": { "type": "boolean" }, "lockedAfterConnect": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ], "additionalProperties": false } }, "placeholder": { "type": "string" }, "default": { "type": "string" }, "help": { "type": "string" }, "advanced": { "type": "boolean" }, "showWhen": { "type": "object", "properties": { "field": { "type": "string" }, "equals": { "type": "array", "items": { "type": "string" } } }, "required": [ "field", "equals" ], "additionalProperties": false } }, "required": [ "key", "label", "type" ], "additionalProperties": false } }, "uninstallsOnDelete": { "type": "boolean" }, "revokesOnDelete": { "type": "boolean" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "capability": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] }, "archetype": { "type": "string", "enum": [ "posture_check", "evidence_pull", "ingest", "dsar_lookup", "dsar_export", "field_scan" ] }, "monitorKey": { "type": "string" }, "monitorKeys": { "type": "array", "items": { "type": "string" } }, "benchmark": { "type": "object", "properties": { "framework": { "type": "string" }, "cisId": { "type": "string" }, "awsControlId": { "type": "string" }, "level": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] } ] }, "benchmarkVersion": { "type": "string" }, "severity": { "type": "string" }, "description": { "type": "string" }, "rationale": { "type": "string" }, "remediation": { "type": "string" }, "references": { "type": "array", "items": { "type": "string" } }, "relatedRequirementIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": {} }, "group": { "type": "string" } }, "required": [ "key", "name", "capability", "archetype" ], "additionalProperties": {} } }, "checkGroups": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "defaultEnabled": { "type": "boolean" }, "checkCount": { "type": "number" } }, "required": [ "key", "label", "description", "defaultEnabled" ], "additionalProperties": false } }, "concordPrincipalArn": { "type": "string" }, "connected": { "type": "boolean" }, "connectionCount": { "type": "number" } }, "required": [ "key", "name", "description", "categories", "authStrategy", "capabilities", "actions" ], "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}/integrations/directory": { "get": { "operationId": "get_platform_v1_organizations_organizationid_integrations_directory", "tags": [ "Integrations" ], "description": "Lists the integrations directory, with this organization's connection state and a count per category.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "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": { "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "logoUrl": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "supports": { "type": "array", "items": { "type": "string", "enum": [ "data_mapping", "dsar", "consent", "controls_evidence" ] } }, "links": { "type": "array", "items": { "type": "string" } }, "featureBullets": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "live", "catalog_only", "coming_soon" ] }, "connectable": { "type": "boolean" }, "manifestKey": { "type": "string" }, "launchFeature": { "type": "string" }, "vendor": { "type": "string" }, "domain": { "type": "string" }, "documentationUrl": { "type": "string", "format": "uri" }, "connected": { "type": "boolean" }, "connectionCount": { "type": "number" }, "rank": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 } }, "required": [ "slug", "name", "description", "categories", "supports", "links", "featureBullets", "status", "connectable" ], "additionalProperties": {} } }, "total": { "type": "number" }, "categories": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "count": { "type": "number" } }, "required": [ "name", "count" ], "additionalProperties": false } } }, "required": [ "items", "total", "categories" ], "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}/integrations/directory/{slug}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_integrations_directory_slug", "tags": [ "Integrations" ], "description": "Returns one integrations directory entry, including its live connector details when one exists.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "slug", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "slug": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "logoUrl": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "supports": { "type": "array", "items": { "type": "string", "enum": [ "data_mapping", "dsar", "consent", "controls_evidence" ] } }, "links": { "type": "array", "items": { "type": "string" } }, "featureBullets": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "live", "catalog_only", "coming_soon" ] }, "connectable": { "type": "boolean" }, "manifestKey": { "type": "string" }, "launchFeature": { "type": "string" }, "vendor": { "type": "string" }, "domain": { "type": "string" }, "documentationUrl": { "type": "string", "format": "uri" }, "connected": { "type": "boolean" }, "connectionCount": { "type": "number" }, "rank": { "type": "integer", "exclusiveMinimum": 0, "maximum": 9007199254740991 }, "live": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilities": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "featureGate": { "type": "string" }, "credentialFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "secret", "number", "boolean", "select", "list", "multiselect" ] }, "required": { "type": "boolean" }, "immutable": { "type": "boolean" }, "lockedAfterConnect": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ], "additionalProperties": false } }, "placeholder": { "type": "string" }, "default": { "type": "string" }, "help": { "type": "string" }, "advanced": { "type": "boolean" }, "showWhen": { "type": "object", "properties": { "field": { "type": "string" }, "equals": { "type": "array", "items": { "type": "string" } } }, "required": [ "field", "equals" ], "additionalProperties": false } }, "required": [ "key", "label", "type" ], "additionalProperties": false } }, "connectionFields": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "type": { "type": "string", "enum": [ "string", "secret", "number", "boolean", "select", "list", "multiselect" ] }, "required": { "type": "boolean" }, "immutable": { "type": "boolean" }, "lockedAfterConnect": { "type": "boolean" }, "options": { "type": "array", "items": { "type": "object", "properties": { "label": { "type": "string" }, "value": { "type": "string" } }, "required": [ "label", "value" ], "additionalProperties": false } }, "placeholder": { "type": "string" }, "default": { "type": "string" }, "help": { "type": "string" }, "advanced": { "type": "boolean" }, "showWhen": { "type": "object", "properties": { "field": { "type": "string" }, "equals": { "type": "array", "items": { "type": "string" } } }, "required": [ "field", "equals" ], "additionalProperties": false } }, "required": [ "key", "label", "type" ], "additionalProperties": false } }, "uninstallsOnDelete": { "type": "boolean" }, "revokesOnDelete": { "type": "boolean" }, "actions": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "name": { "type": "string" }, "description": { "type": "string" }, "capability": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] }, "archetype": { "type": "string", "enum": [ "posture_check", "evidence_pull", "ingest", "dsar_lookup", "dsar_export", "field_scan" ] }, "monitorKey": { "type": "string" }, "monitorKeys": { "type": "array", "items": { "type": "string" } }, "benchmark": { "type": "object", "properties": { "framework": { "type": "string" }, "cisId": { "type": "string" }, "awsControlId": { "type": "string" }, "level": { "anyOf": [ { "type": "number", "enum": [ 1 ] }, { "type": "number", "enum": [ 2 ] } ] }, "benchmarkVersion": { "type": "string" }, "severity": { "type": "string" }, "description": { "type": "string" }, "rationale": { "type": "string" }, "remediation": { "type": "string" }, "references": { "type": "array", "items": { "type": "string" } }, "relatedRequirementIds": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": {} }, "group": { "type": "string" } }, "required": [ "key", "name", "capability", "archetype" ], "additionalProperties": {} } }, "checkGroups": { "type": "array", "items": { "type": "object", "properties": { "key": { "type": "string" }, "label": { "type": "string" }, "description": { "type": "string" }, "defaultEnabled": { "type": "boolean" }, "checkCount": { "type": "number" } }, "required": [ "key", "label", "description", "defaultEnabled" ], "additionalProperties": false } }, "concordPrincipalArn": { "type": "string" }, "connected": { "type": "boolean" }, "connectionCount": { "type": "number" } }, "required": [ "key", "name", "description", "categories", "authStrategy", "capabilities", "actions" ], "additionalProperties": {} } }, "required": [ "slug", "name", "description", "categories", "supports", "links", "featureBullets", "status", "connectable" ], "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}/connections": { "post": { "operationId": "post_platform_v1_organizations_organizationid_connections", "tags": [ "Integrations" ], "description": "Connects an integration. OAuth integrations get their credential later through the authorize flow.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "integrationKey": { "type": "string", "minLength": 1 }, "label": { "type": "string", "minLength": 1, "maxLength": 256 }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "credential": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } } }, "required": [ "integrationKey" ] } } }, "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" }, "integrationKey": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "permissionsHealth": { "type": "object", "properties": { "deniedActions": { "type": "array", "items": { "type": "string" } }, "affectedAccounts": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "deniedActions", "affectedAccounts" ], "additionalProperties": false }, "hasCredential": { "type": "boolean" }, "credentialVersion": { "type": "number" }, "lastConnectedAt": { "type": "string" }, "lastError": { "type": "string" }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "integrationKey", "status", "authStrategy", "capabilitiesEnabled", "hasCredential" ], "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_platform_v1_organizations_organizationid_connections", "tags": [ "Integrations" ], "description": "Lists this organization's connections.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "integrationKey", "required": false }, { "schema": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "in": "query", "name": "status", "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" }, "integrationKey": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "permissionsHealth": { "type": "object", "properties": { "deniedActions": { "type": "array", "items": { "type": "string" } }, "affectedAccounts": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "deniedActions", "affectedAccounts" ], "additionalProperties": false }, "hasCredential": { "type": "boolean" }, "credentialVersion": { "type": "number" }, "lastConnectedAt": { "type": "string" }, "lastError": { "type": "string" }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "integrationKey", "status", "authStrategy", "capabilitiesEnabled", "hasCredential" ], "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}/connections/{connectionId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_connections_connectionid", "tags": [ "Integrations" ], "description": "Returns one connection.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "integrationKey": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "permissionsHealth": { "type": "object", "properties": { "deniedActions": { "type": "array", "items": { "type": "string" } }, "affectedAccounts": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "deniedActions", "affectedAccounts" ], "additionalProperties": false }, "hasCredential": { "type": "boolean" }, "credentialVersion": { "type": "number" }, "lastConnectedAt": { "type": "string" }, "lastError": { "type": "string" }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "integrationKey", "status", "authStrategy", "capabilitiesEnabled", "hasCredential" ], "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_platform_v1_organizations_organizationid_connections_connectionid", "tags": [ "Integrations" ], "description": "Updates a connection's label, settings or capabilities, or turns it on or off.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "label": { "type": "string", "minLength": 1, "maxLength": 256 }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "status": { "type": "string", "enum": [ "connected", "disabled" ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "integrationKey": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "permissionsHealth": { "type": "object", "properties": { "deniedActions": { "type": "array", "items": { "type": "string" } }, "affectedAccounts": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "deniedActions", "affectedAccounts" ], "additionalProperties": false }, "hasCredential": { "type": "boolean" }, "credentialVersion": { "type": "number" }, "lastConnectedAt": { "type": "string" }, "lastError": { "type": "string" }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "integrationKey", "status", "authStrategy", "capabilitiesEnabled", "hasCredential" ], "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_platform_v1_organizations_organizationid_connections_connectionid", "tags": [ "Integrations" ], "description": "Deletes a connection, its credential and its generated actions. Run history and control evidence are kept.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" }, "actionsRemoved": { "type": "number" }, "actionsReleased": { "type": "number" }, "credentialsRemoved": { "type": "number" }, "inventoryRemoved": { "type": "number" } }, "required": [ "deleted", "actionsRemoved", "actionsReleased", "credentialsRemoved", "inventoryRemoved" ], "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}/connections/{connectionId}/credential": { "post": { "operationId": "post_platform_v1_organizations_organizationid_connections_connectionid_credential", "tags": [ "Integrations" ], "description": "Replaces a connection's credential.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "credential": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "credential" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "integrationKey": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "permissionsHealth": { "type": "object", "properties": { "deniedActions": { "type": "array", "items": { "type": "string" } }, "affectedAccounts": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "deniedActions", "affectedAccounts" ], "additionalProperties": false }, "hasCredential": { "type": "boolean" }, "credentialVersion": { "type": "number" }, "lastConnectedAt": { "type": "string" }, "lastError": { "type": "string" }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "integrationKey", "status", "authStrategy", "capabilitiesEnabled", "hasCredential" ], "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}/connections/{connectionId}/test": { "post": { "operationId": "post_platform_v1_organizations_organizationid_connections_connectionid_test", "tags": [ "Integrations" ], "description": "Tests a connection's credential against the provider, so a revoked grant shows as an error.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "integrationKey": { "type": "string" }, "label": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "connected", "error", "disabled", "revoked" ] }, "authStrategy": { "type": "string", "enum": [ "oauth2", "api_key", "aws_assume_role", "aws_keys", "azure_service_principal", "gcp_workload_identity", "oci_api_key" ] }, "capabilitiesEnabled": { "type": "array", "items": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] } }, "config": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "permissionsHealth": { "type": "object", "properties": { "deniedActions": { "type": "array", "items": { "type": "string" } }, "affectedAccounts": { "type": "array", "items": { "type": "string" } }, "firstSeenAt": { "type": "string" }, "lastSeenAt": { "type": "string" } }, "required": [ "deniedActions", "affectedAccounts" ], "additionalProperties": false }, "hasCredential": { "type": "boolean" }, "credentialVersion": { "type": "number" }, "lastConnectedAt": { "type": "string" }, "lastError": { "type": "string" }, "createdByUserId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "integrationKey", "status", "authStrategy", "capabilitiesEnabled", "hasCredential" ], "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}/connections/{connectionId}/run": { "post": { "operationId": "post_platform_v1_organizations_organizationid_connections_connectionid_run", "tags": [ "Integrations" ], "description": "Runs one action on a connection.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "action": { "type": "string", "minLength": 1 }, "input": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} } }, "required": [ "action" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "connectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "connectionId": { "type": "string" }, "integrationKey": { "type": "string" }, "action": { "type": "string" }, "archetype": { "type": "string", "enum": [ "posture_check", "evidence_pull", "ingest", "dsar_lookup", "dsar_export", "field_scan" ] }, "status": { "type": "string", "enum": [ "pending", "running", "succeeded", "failed", "skipped" ] }, "trigger": { "type": "string" }, "startedAt": { "type": "string" }, "finishedAt": { "type": "string" }, "durationMs": { "type": "number" }, "error": { "type": "string" }, "summary": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": {} }, "complianceRequestId": { "type": "string" }, "controlTestRunId": { "type": "string" }, "usageEventId": { "type": "string" }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "connectionId", "integrationKey", "action", "archetype", "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}/actions/library": { "get": { "operationId": "get_platform_v1_organizations_organizationid_actions_library", "tags": [ "Integrations" ], "description": "Lists the actions you can run across all integrations, with this organization's connection state.", "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": { "integrationKey": { "type": "string" }, "integrationName": { "type": "string" }, "integrationSlug": { "type": "string" }, "capability": { "type": "string", "enum": [ "dsar_lookup", "dsar_export", "field_scan", "check", "send", "ingest", "evidence_pull", "power_ai" ] }, "name": { "type": "string" }, "description": { "type": "string" }, "deliverables": { "type": "array", "items": { "type": "string" } }, "agentBinding": { "type": "string", "enum": [ "required", "optional", "none" ] }, "automations": { "type": "array", "items": { "type": "string", "enum": [ "schedule", "trigger" ] } }, "aiPowered": { "type": "boolean" }, "actionCount": { "type": "number" }, "costActions": { "type": "number" }, "logoUrl": { "type": "string" }, "connected": { "type": "boolean" } }, "required": [ "integrationKey", "integrationName", "integrationSlug", "capability", "name", "description", "deliverables", "agentBinding", "automations", "aiPowered", "actionCount", "costActions" ], "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}/integrations/{integrationKey}/authorize": { "post": { "operationId": "post_platform_v1_organizations_organizationid_integrations_integrationkey_authorize", "tags": [ "Integrations" ], "description": "Starts connecting an OAuth integration and returns the provider URL to authorize it.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "returnTo": { "type": "string" }, "connectionId": { "type": "string" }, "providerReturnUrl": { "type": "string" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "integrationKey", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "authorizeUrl": { "type": "string" }, "connectionId": { "type": "string" }, "state": { "type": "string" } }, "required": [ "authorizeUrl", "connectionId", "state" ], "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}/integrations/oauth/complete": { "post": { "operationId": "post_platform_v1_organizations_organizationid_integrations_oauth_complete", "tags": [ "Integrations" ], "description": "Finishes connecting an OAuth integration that this organization started.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "state": { "type": "string", "minLength": 1 }, "code": { "type": "string", "minLength": 1 } }, "required": [ "state", "code" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "connectionId": { "type": "string" }, "organizationId": { "type": "string" }, "integrationKey": { "type": "string" }, "returnTo": { "type": "string" } }, "required": [ "connectionId", "organizationId", "integrationKey" ], "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}/tasks": { "post": { "operationId": "post_platform_v1_organizations_organizationid_tasks", "summary": "Create a task", "tags": [ "Tasks" ], "description": "Creates a task in the organization work system.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "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": { "type": "string", "enum": [ "user", "agent", "system" ] }, "assigneeId": { "type": "string" }, "statusCategory": { "type": "string", "enum": [ "backlog", "todo", "in_progress", "done", "cancelled" ] }, "status": { "type": "string" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ] }, "dueAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "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" }, "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" ] } } } } } }, "get": { "operationId": "get_platform_v1_organizations_organizationid_tasks", "summary": "List tasks", "tags": [ "Tasks" ], "description": "Returns the organization's tasks, optionally filtered by status, assignee, priority, type, source, or due date.", "parameters": [ { "schema": { "type": "string", "enum": [ "user", "agent", "system" ] }, "in": "query", "name": "assigneeType", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "assigneeId", "required": false }, { "schema": { "type": "string", "enum": [ "backlog", "todo", "in_progress", "done", "cancelled" ] }, "in": "query", "name": "statusCategory", "required": false }, { "schema": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ] }, "in": "query", "name": "priority", "required": false }, { "schema": { "type": "string", "enum": [ "control", "requirement_gap", "privacy_request", "data_system", "compliance_scan", "tracker_scan", "gcm_scan", "risk", "vendor", "assessment" ] }, "in": "query", "name": "type", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "referenceId", "required": false }, { "schema": { "type": "string", "enum": [ "manual", "test", "integration", "system", "agent", "auditor" ] }, "in": "query", "name": "source", "required": false }, { "schema": { "type": "string", "enum": [ "true", "false" ] }, "in": "query", "name": "open", "required": false }, { "schema": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "in": "query", "name": "dueBefore", "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" }, "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": {} } }, "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}/tasks/from-gap": { "post": { "operationId": "post_platform_v1_organizations_organizationid_tasks_from_gap", "summary": "Create a task from a coverage gap", "tags": [ "Tasks" ], "description": "Creates a task for a compliance framework requirement gap or a named control, scoped to the adopted framework.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "organizationFrameworkId": { "type": "string", "minLength": 1 }, "frameworkRequirementId": { "type": "string", "minLength": 1 }, "controlId": { "type": "string" }, "title": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "assigneeType": { "type": "string", "enum": [ "user", "agent", "system" ] }, "assigneeId": { "type": "string" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ] }, "dueAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "organizationFrameworkId", "frameworkRequirementId" ] } } }, "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" }, "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" ] } } } } } } }, "/organizations/{organizationId}/tasks/{taskId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_tasks_taskid", "summary": "Get a task", "tags": [ "Tasks" ], "description": "Returns a single task by its ID.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "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" ] } } } } } }, "patch": { "operationId": "patch_platform_v1_organizations_organizationid_tasks_taskid", "summary": "Update a task", "tags": [ "Tasks" ], "description": "Updates a task's editable fields such as title, description, priority, and due date.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "title": { "type": "string", "minLength": 1 }, "description": { "type": "string" }, "priority": { "type": "string", "enum": [ "low", "medium", "high", "urgent" ] }, "dueAt": { "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": [ "" ] } ] }, "blockedBy": { "type": "array", "items": { "type": "string" } }, "blockedReason": { "type": "string" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "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" ] } } } } } } }, "/organizations/{organizationId}/tasks/{taskId}/transition": { "post": { "operationId": "post_platform_v1_organizations_organizationid_tasks_taskid_transition", "summary": "Transition a task's status", "tags": [ "Tasks" ], "description": "Moves a task to a new status category and records who resolved it when the new status is done or cancelled.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCategory": { "type": "string", "enum": [ "backlog", "todo", "in_progress", "done", "cancelled" ] }, "status": { "type": "string" }, "cancelReason": { "type": "string" } }, "required": [ "statusCategory" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "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" ] } } } } } } }, "/organizations/{organizationId}/tasks/{taskId}/assign": { "post": { "operationId": "post_platform_v1_organizations_organizationid_tasks_taskid_assign", "summary": "Assign a task", "tags": [ "Tasks" ], "description": "Assigns a task to a user, agent, or system, or unassigns it when both fields are null.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "assigneeType": { "anyOf": [ { "type": "string", "enum": [ "user", "agent", "system" ] }, { "type": "null" } ] }, "assigneeId": { "anyOf": [ { "type": "string", "minLength": 1 }, { "type": "null" } ] } }, "required": [ "assigneeType", "assigneeId" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "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" ] } } } } } } }, "/organizations/{organizationId}/vendors": { "post": { "operationId": "post_platform_v1_organizations_organizationid_vendors", "summary": "Create a vendor", "tags": [ "Vendors" ], "description": "Creates a vendor record in the organization vendor inventory.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "globalVendorId": { "type": "string" }, "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "legalName": { "type": "string", "maxLength": 256 }, "websiteUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "string", "enum": [ "" ] } ] }, "privacyPolicyUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "string", "enum": [ "" ] } ] }, "country": { "anyOf": [ { "type": "string", "pattern": "^[A-Z]{2}$" }, { "type": "string", "enum": [ "" ] } ] }, "description": { "type": "string", "maxLength": 2000 }, "icon": { "type": "string", "maxLength": 500000, "pattern": "^$|^\\/integrations\\/|^data:image\\/|^https:\\/\\/" }, "categories": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "inherentRiskTier": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, { "type": "string", "enum": [ "" ] } ] }, "dataSensitivity": { "anyOf": [ { "type": "string", "enum": [ "none", "internal", "confidential", "regulated" ] }, { "type": "string", "enum": [ "" ] } ] }, "usesAi": { "type": "boolean" }, "aiTrainsOnCustomerData": { "type": "boolean" }, "hasPrivilegedAccess": { "type": "boolean" }, "ownerUserId": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "enum": [ "" ] } ] }, "securityOwnerUserId": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "enum": [ "" ] } ] }, "reviewFrequency": { "anyOf": [ { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, { "type": "string", "enum": [ "" ] } ] }, "dataSystemIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } } } } } } }, "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" }, "globalVendorId": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": "string" }, "websiteUrl": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "dataSystemIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] }, "inherentRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "inherentRiskTierSource": { "type": "string", "enum": [ "auto", "manual" ] }, "dataSensitivity": { "type": "string", "enum": [ "none", "internal", "confidential", "regulated" ] }, "dataSensitivitySource": { "type": "string", "enum": [ "auto", "manual" ] }, "usesAi": { "type": "boolean" }, "aiTrainsOnCustomerData": { "type": "boolean" }, "hasPrivilegedAccess": { "type": "boolean" }, "ownerUserId": { "type": "string" }, "securityOwnerUserId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "residualRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "name", "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_platform_v1_organizations_organizationid_vendors", "summary": "List vendors", "tags": [ "Vendors" ], "description": "Returns the vendors in the organization vendor inventory.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "dataSystemId", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string", "enum": [ "never_reviewed", "in_progress", "reviewed" ] }, "in": "query", "name": "reviewState", "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" }, "globalVendorId": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": "string" }, "websiteUrl": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "dataSystemIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] }, "inherentRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "inherentRiskTierSource": { "type": "string", "enum": [ "auto", "manual" ] }, "dataSensitivity": { "type": "string", "enum": [ "none", "internal", "confidential", "regulated" ] }, "dataSensitivitySource": { "type": "string", "enum": [ "auto", "manual" ] }, "usesAi": { "type": "boolean" }, "aiTrainsOnCustomerData": { "type": "boolean" }, "hasPrivilegedAccess": { "type": "boolean" }, "ownerUserId": { "type": "string" }, "securityOwnerUserId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "residualRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "name", "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}/vendors/{vendorId}": { "get": { "operationId": "get_platform_v1_organizations_organizationid_vendors_vendorid", "summary": "Get a vendor", "tags": [ "Vendors" ], "description": "Returns a single vendor by ID.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "globalVendorId": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": "string" }, "websiteUrl": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "dataSystemIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] }, "inherentRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "inherentRiskTierSource": { "type": "string", "enum": [ "auto", "manual" ] }, "dataSensitivity": { "type": "string", "enum": [ "none", "internal", "confidential", "regulated" ] }, "dataSensitivitySource": { "type": "string", "enum": [ "auto", "manual" ] }, "usesAi": { "type": "boolean" }, "aiTrainsOnCustomerData": { "type": "boolean" }, "hasPrivilegedAccess": { "type": "boolean" }, "ownerUserId": { "type": "string" }, "securityOwnerUserId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "residualRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "name", "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" ] } } } } } }, "patch": { "operationId": "patch_platform_v1_organizations_organizationid_vendors_vendorid", "summary": "Update a vendor", "tags": [ "Vendors" ], "description": "Updates fields on an existing vendor.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "legalName": { "type": "string", "maxLength": 256 }, "websiteUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "string", "enum": [ "" ] } ] }, "privacyPolicyUrl": { "anyOf": [ { "type": "string", "maxLength": 2048, "format": "uri" }, { "type": "string", "enum": [ "" ] } ] }, "country": { "anyOf": [ { "type": "string", "pattern": "^[A-Z]{2}$" }, { "type": "string", "enum": [ "" ] } ] }, "description": { "type": "string", "maxLength": 2000 }, "icon": { "type": "string", "maxLength": 500000, "pattern": "^$|^\\/integrations\\/|^data:image\\/|^https:\\/\\/" }, "categories": { "maxItems": 20, "type": "array", "items": { "type": "string", "minLength": 1, "maxLength": 64 } }, "inherentRiskTier": { "anyOf": [ { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, { "type": "string", "enum": [ "" ] } ] }, "dataSensitivity": { "anyOf": [ { "type": "string", "enum": [ "none", "internal", "confidential", "regulated" ] }, { "type": "string", "enum": [ "" ] } ] }, "usesAi": { "type": "boolean" }, "aiTrainsOnCustomerData": { "type": "boolean" }, "hasPrivilegedAccess": { "type": "boolean" }, "ownerUserId": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "enum": [ "" ] } ] }, "securityOwnerUserId": { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "enum": [ "" ] } ] }, "reviewFrequency": { "anyOf": [ { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, { "type": "string", "enum": [ "" ] } ] }, "dataSystemIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } }, "addDataSystemIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } }, "removeDataSystemIds": { "maxItems": 500, "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "globalVendorId": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": "string" }, "websiteUrl": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "dataSystemIds": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] }, "inherentRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "inherentRiskTierSource": { "type": "string", "enum": [ "auto", "manual" ] }, "dataSensitivity": { "type": "string", "enum": [ "none", "internal", "confidential", "regulated" ] }, "dataSensitivitySource": { "type": "string", "enum": [ "auto", "manual" ] }, "usesAi": { "type": "boolean" }, "aiTrainsOnCustomerData": { "type": "boolean" }, "hasPrivilegedAccess": { "type": "boolean" }, "ownerUserId": { "type": "string" }, "securityOwnerUserId": { "type": "string" }, "reviewFrequency": { "type": "string", "enum": [ "annual", "semi_annual", "quarterly" ] }, "lastReviewedAt": {}, "nextReviewDueAt": {}, "residualRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "name", "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" ] } } } } } }, "delete": { "operationId": "delete_platform_v1_organizations_organizationid_vendors_vendorid", "summary": "Delete a vendor", "tags": [ "Vendors" ], "description": "Deletes a vendor unless it is still listed as a sub-processor on a trust center.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "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}/vendors/import": { "post": { "operationId": "post_platform_v1_organizations_organizationid_vendors_import", "summary": "Import vendors", "tags": [ "Vendors" ], "description": "Imports vendors from a CSV file into the organization vendor inventory.", "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}/vendors/summary": { "get": { "operationId": "get_platform_v1_organizations_organizationid_vendors_summary", "summary": "Get vendor summary", "tags": [ "Vendors" ], "description": "Returns counts of vendors in the organization by review status.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "reviewed": { "type": "number" }, "inProgress": { "type": "number" }, "neverReviewed": { "type": "number" }, "total": { "type": "number" } }, "required": [ "reviewed", "inProgress", "neverReviewed", "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}/vendors/{vendorId}/reviews": { "post": { "operationId": "post_platform_v1_organizations_organizationid_vendors_vendorid_reviews", "summary": "Create a vendor review", "tags": [ "Vendors" ], "description": "Opens a new review for a vendor.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "reviewerUserId": { "type": "string", "maxLength": 128 }, "findings": { "type": "string", "maxLength": 5000 }, "periodStart": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } } } } } }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "vendorId": { "type": "string" }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected" ] }, "reviewerUserId": { "type": "string" }, "decidedByUserId": { "type": "string" }, "riskTierAtReview": { "type": "string" }, "findings": { "type": "string" }, "decisionNotes": { "type": "string" }, "riskId": { "type": "string" }, "completedAt": {}, "periodStart": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "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_platform_v1_organizations_organizationid_vendors_vendorid_reviews", "summary": "List vendor reviews", "tags": [ "Vendors" ], "description": "Returns the reviews recorded for a vendor.", "parameters": [ { "schema": { "type": "string", "enum": [ "in_progress", "approved", "rejected" ] }, "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 }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "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" }, "vendorId": { "type": "string" }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected" ] }, "reviewerUserId": { "type": "string" }, "decidedByUserId": { "type": "string" }, "riskTierAtReview": { "type": "string" }, "findings": { "type": "string" }, "decisionNotes": { "type": "string" }, "riskId": { "type": "string" }, "completedAt": {}, "periodStart": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "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}/vendors/{vendorId}/reviews/{reviewId}": { "patch": { "operationId": "patch_platform_v1_organizations_organizationid_vendors_vendorid_reviews_reviewid", "summary": "Update a vendor review", "tags": [ "Vendors" ], "description": "Approves or rejects an open vendor review.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "approved", "rejected" ] }, "findings": { "type": "string", "maxLength": 5000 }, "decisionNotes": { "type": "string", "maxLength": 5000 }, "residualRiskTier": { "type": "string", "enum": [ "critical", "high", "medium", "low" ] } }, "required": [ "status" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "reviewId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "vendorId": { "type": "string" }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected" ] }, "reviewerUserId": { "type": "string" }, "decidedByUserId": { "type": "string" }, "riskTierAtReview": { "type": "string" }, "findings": { "type": "string" }, "decisionNotes": { "type": "string" }, "riskId": { "type": "string" }, "completedAt": {}, "periodStart": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "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}/vendors/{vendorId}/reviews/{reviewId}/risk": { "post": { "operationId": "post_platform_v1_organizations_organizationid_vendors_vendorid_reviews_reviewid_risk", "summary": "Raise a risk from a vendor review", "tags": [ "Vendors" ], "description": "Adds a risk to the register from a review's findings and links it to the review. A review raises at most one risk.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "reviewId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "vendorId": { "type": "string" }, "status": { "type": "string", "enum": [ "in_progress", "approved", "rejected" ] }, "reviewerUserId": { "type": "string" }, "decidedByUserId": { "type": "string" }, "riskTierAtReview": { "type": "string" }, "findings": { "type": "string" }, "decisionNotes": { "type": "string" }, "riskId": { "type": "string" }, "completedAt": {}, "periodStart": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "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}/vendors/{vendorId}/documents": { "post": { "operationId": "post_platform_v1_organizations_organizationid_vendors_vendorid_documents", "summary": "Create a vendor document", "tags": [ "Vendors" ], "description": "Creates a vendor document as a link to existing evidence, an external URL, or an uploaded file.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "documentType": { "type": "string", "enum": [ "soc2", "iso27001", "pen_test", "dpa", "insurance", "questionnaire", "other" ] }, "evidenceId": { "type": "string", "maxLength": 128 }, "externalUrl": { "type": "string", "maxLength": 2048, "format": "uri" }, "validFrom": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" }, "expiresAt": { "type": "string", "pattern": "^\\d{4}-\\d{2}-\\d{2}([T ]\\d{2}:\\d{2}(:\\d{2}(\\.\\d+)?)?(Z|[+-]\\d{2}:?\\d{2})?)?$" } }, "required": [ "documentType" ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "vendorId": { "type": "string" }, "documentType": { "type": "string", "enum": [ "soc2", "iso27001", "pen_test", "dpa", "insurance", "questionnaire", "other" ] }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "validFrom": {}, "expiresAt": {}, "renewalReminderAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "documentType" ], "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_platform_v1_organizations_organizationid_vendors_vendorid_documents", "summary": "List vendor documents", "tags": [ "Vendors" ], "description": "Returns the documents on file for a vendor.", "parameters": [ { "schema": { "type": "string", "enum": [ "soc2", "iso27001", "pen_test", "dpa", "insurance", "questionnaire", "other" ] }, "in": "query", "name": "documentType", "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": "vendorId", "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" }, "vendorId": { "type": "string" }, "documentType": { "type": "string", "enum": [ "soc2", "iso27001", "pen_test", "dpa", "insurance", "questionnaire", "other" ] }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "validFrom": {}, "expiresAt": {}, "renewalReminderAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "documentType" ], "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}/vendors/{vendorId}/documents/upload": { "post": { "operationId": "post_platform_v1_organizations_organizationid_vendors_vendorid_documents_upload", "summary": "Upload a vendor document file", "tags": [ "Vendors" ], "description": "Uploads a file and adds it as a document on a vendor.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string" }, "organizationId": { "type": "string" }, "vendorId": { "type": "string" }, "documentType": { "type": "string", "enum": [ "soc2", "iso27001", "pen_test", "dpa", "insurance", "questionnaire", "other" ] }, "evidenceId": { "type": "string" }, "externalUrl": { "type": "string" }, "asset": { "type": "object", "properties": { "bucket": { "type": "string" }, "key": { "type": "string" }, "fileName": { "type": "string" }, "contentType": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "bucket", "key" ], "additionalProperties": false }, "validFrom": {}, "expiresAt": {}, "renewalReminderAt": {}, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "organizationId", "vendorId", "documentType" ], "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}/vendors/{vendorId}/documents/{documentId}/file": { "get": { "operationId": "get_platform_v1_organizations_organizationid_vendors_vendorid_documents_documentid_file", "summary": "Get a vendor document file URL", "tags": [ "Vendors" ], "description": "Returns a short-lived signed URL for downloading a vendor document file.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "documentId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "url": { "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}/vendors/{vendorId}/documents/{documentId}": { "delete": { "operationId": "delete_platform_v1_organizations_organizationid_vendors_vendorid_documents_documentid", "summary": "Delete a vendor document", "tags": [ "Vendors" ], "description": "Deletes a vendor document and removes its uploaded file from storage if one exists.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "vendorId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "documentId", "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}/global-vendors": { "get": { "operationId": "get_platform_v1_organizations_organizationid_global_vendors", "summary": "List global vendors", "tags": [ "Vendors" ], "description": "Searches the active entries in the global vendor catalog.", "parameters": [ { "schema": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, "in": "query", "name": "id", "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" }, "slug": { "type": "string" }, "name": { "type": "string" }, "legalName": { "type": "string" }, "websiteUrl": { "type": "string" }, "privacyPolicyUrl": { "type": "string" }, "dpaUrl": { "type": "string" }, "country": { "type": "string" }, "description": { "type": "string" }, "icon": { "type": "string" }, "categories": { "type": "array", "items": { "type": "string" } }, "domains": { "type": "array", "items": { "type": "string" } }, "status": { "type": "string", "enum": [ "active", "archived", "pending_review", "rejected" ] }, "dateCreated": {}, "dateUpdated": {} }, "required": [ "id", "slug", "name", "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" ] } } } } } } } }, "servers": [ { "url": "https://api.concord.tech/platform-v1", "description": "Concord Platform API" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "Actions", "description": "Actions library endpoints." }, { "name": "Documents", "description": "Document endpoints." }, { "name": "Form Submissions", "description": "Form submission endpoints." }, { "name": "Form Templates", "description": "Form template endpoints." }, { "name": "Integrations", "description": "Integration and connection endpoints." }, { "name": "Organizations", "description": "Organization endpoints." }, { "name": "SSO", "description": "Single sign-on endpoints." }, { "name": "Tasks", "description": "Task endpoints." }, { "name": "Vendors", "description": "Vendor endpoints." }, { "name": "Forms", "description": "Form endpoints." }, { "name": "Assessments", "description": "Assessment endpoints." }, { "name": "Controls (super admin)", "description": "Staff endpoints for control feature overrides." }, { "name": "Integrations (super admin)", "description": "Staff endpoints for the integrations directory." } ] }