{ "openapi": "3.1.0", "info": { "title": "Concord Privacy API", "description": "The Concord Privacy API provide full access to the Concord platform for registered organizations.", "version": "4.32.1", "contact": { "email": "support@concord.tech", "name": "Concord Technologies Inc.", "url": "https://www.concord.tech" }, "license": { "name": "Proprietary", "url": "https://www.concord.tech/legal/saas-agreement" }, "termsOfService": "https://www.concord.tech/legal/saas-agreement" }, "components": { "securitySchemes": { "ApiKeyAuth": { "name": "x-api-key", "type": "apiKey", "in": "header", "description": "" } }, "schemas": {} }, "paths": { "/organizations/{organizationId}/mapped-global-data-systems": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_mapped_global_data_systems", "summary": "Get mapped global data systems", "tags": [ "Data Systems" ], "description": "Gets the global data systems with attributes mapped to organization level ids.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "name": { "type": "string", "maxLength": 256 }, "icon": { "type": "string" }, "vendorSlug": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "slug": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } } }, "required": [ "id", "dateCreated", "dateUpdated", "name", "status" ], "additionalProperties": false } } }, "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}/api-keys/{apiKey}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_api_keys_apikey", "summary": "Delete API key by ID", "tags": [ "API Keys" ], "description": "Deletes an API key.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "apiKey", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "apiKey": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": true } } }, "required": [ "apiKey", "role", "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_privacy_v1_organizations_organizationid_api_keys_apikey", "summary": "Update API key", "tags": [ "API Keys" ], "description": "Updates an API key.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 1024 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "apiKey", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "apiKey": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": true } } }, "required": [ "apiKey", "role", "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}/api-keys": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_api_keys", "summary": "Get API keys", "tags": [ "API Keys" ], "description": "Gets the API keys for an organization.", "parameters": [ { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "apiKey", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "projectName", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "role", "required": false }, { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "in": "query", "name": "projectIds", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "apiKey": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": true } } }, "required": [ "apiKey", "role", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_api_keys", "summary": "Create API key", "tags": [ "API Keys" ], "description": "Creates a new API key.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 1, "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] }, "permissions": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "organizationId": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": false } } }, "required": [ "name", "permissions" ], "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" }, "apiKey": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": true } } }, "required": [ "apiKey", "role", "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}/public-keys/{kid}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_public_keys_kid", "summary": "Delete public key", "tags": [ "Public Keys" ], "description": "Deletes a JWT public key by its key ID (kid).", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "minLength": 1, "maxLength": 256 }, "in": "path", "name": "kid", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "deleted": { "type": "boolean" } }, "required": [ "deleted" ], "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}/public-keys": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_public_keys", "summary": "Get public keys", "tags": [ "Public Keys" ], "description": "Gets the JWT public keys for an organization. These keys are used to verify authenticated identify requests.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "keys": { "type": "array", "items": { "type": "object", "properties": { "kid": { "type": "string" }, "jwk": { "type": "object", "properties": {}, "additionalProperties": false }, "createdAt": { "type": "string", "format": "date-time" } }, "required": [ "kid", "jwk" ], "additionalProperties": false } } }, "required": [ "keys" ], "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_privacy_v1_organizations_organizationid_public_keys", "summary": "Add public key", "tags": [ "Public Keys" ], "description": "Uploads a JWT public key (JWK format) for authenticated identify requests.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "kid": { "type": "string", "minLength": 1, "maxLength": 256 }, "jwk": { "type": "object", "properties": {}, "additionalProperties": false } }, "required": [ "kid", "jwk" ], "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": { "kid": { "type": "string" }, "createdAt": { "type": "string" } }, "required": [ "kid", "createdAt" ], "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}/compliance-requests": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_compliance_requests", "summary": "Get organization level compliance requests", "tags": [ "Compliance Requests" ], "description": "Gets compliance requests for an organization.", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "in": "query", "name": "projectIds", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "concordId", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "complianceRequestId", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "endDate", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "geography", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "notes", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "requestDetails", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "resolution", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] } }, { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] } ] }, "in": "query", "name": "request", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ] }, { "type": "array", "items": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ] } } ] }, "in": "query", "name": "resolutionStatus", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] } }, { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "sessionId", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "startDate", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "text", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "userEmail", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "userAgent", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "downloadDate": { "type": "integer" }, "filePurgeDate": { "type": "integer" }, "files": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "apiKey": { "type": "string" }, "date": { "type": "integer" }, "dateCreated": { "type": "integer" }, "details": { "type": "string" }, "event": { "type": "string" }, "fileName": { "type": "string", "maxLength": 255 }, "filePath": { "type": "string" }, "fileSize": { "type": "number", "maximum": 10485760 }, "bucket": { "type": "string" }, "key": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "fileName" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid" }, "acknowledgedDate": { "type": "integer" }, "captureUrl": { "type": "string" }, "concordId": { "type": "string", "format": "uuid" }, "dataSystemTasks": { "type": "array", "items": { "type": "object", "properties": { "dataSystem": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "icon": { "type": "string" }, "dataSystemTypeId": { "type": "string" } }, "additionalProperties": false } ] }, "trustCenter": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "completed": { "type": "boolean" }, "completedAt": { "type": "integer" }, "completedBy": { "type": "string" }, "completionRecord": { "type": "object", "properties": {}, "additionalProperties": true } }, "required": [ "completed" ], "additionalProperties": false } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "domain": { "type": "string" }, "notes": { "type": "string", "maxLength": 2048 }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "preverified": { "type": "boolean" }, "resolution": { "type": "string", "maxLength": 2048 }, "resolutionStatus": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ], "maxLength": 2048 }, "resolvedDate": { "type": "string", "format": "date-time" }, "request": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] }, "requestDate": { "type": "integer" }, "requestDetails": { "type": "string" }, "session": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "anyOf": [ { "enum": [ "localhost" ] }, { "type": "string" } ] }, "geography": { "type": "string" }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] }, "user": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false }, "verifiedDate": { "type": "integer" }, "verificationMethod": { "type": "string", "enum": [ "email", "sms" ] }, "verificationRequestId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "concordId", "requestDate" ], "additionalProperties": false } } }, "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}/compliance-requests-events": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_compliance_requests_events", "summary": "Get organization level compliance requests events", "tags": [ "Compliance Requests" ], "description": "Gets compliance request events for an organization.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "accountId", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "complianceRequestId", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "complianceRequestEventId", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "endDate", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "startDate", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "complianceRequestId": { "type": "string", "format": "uuid" }, "details": { "type": "object", "properties": { "downloadedFilesCount": { "type": "number" }, "uploadedFilesCount": { "type": "number" }, "requestDownloadId": { "type": "string", "format": "uuid" }, "fileName": { "type": "string", "maxLength": 255 } }, "additionalProperties": false }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" } }, "required": [ "complianceRequestId", "event", "organizationId", "projectId" ], "additionalProperties": false } } }, "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}/compliance-requests/{complianceRequestId}/connector-results": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_compliance_requests_compliancerequestid_connector_results", "tags": [ "Integrations" ], "description": "Returns each connection's result for a compliance request, including a link to it in the provider.", "parameters": [ { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "complianceRequestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "complianceRequestId": { "type": "string" }, "items": { "type": "array", "items": { "type": "object", "properties": { "integrationKey": { "type": "string" }, "connectionId": { "type": "string" }, "action": { "type": "string" }, "status": { "type": "string" }, "matchedRecordCount": { "type": "number" }, "actionRunId": { "type": "string" }, "downloadId": { "type": "string" }, "providerUrl": { "type": "string" }, "matches": { "type": "array", "items": { "type": "object", "properties": { "object": { "type": "string" }, "url": { "type": "string" } }, "required": [ "object", "url" ], "additionalProperties": false } }, "error": { "type": "string" }, "checkedAt": {}, "connectionRemoved": { "type": "boolean" } }, "required": [ "integrationKey", "connectionId", "action", "status" ], "additionalProperties": {} } } }, "required": [ "complianceRequestId", "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}/consent-events": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_consent_events", "summary": "Get organization level consent events", "tags": [ "Consent Events" ], "description": "Gets consent events for an organization.", "parameters": [ { "schema": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "in": "query", "name": "projectIds", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "startDate", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "endDate", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "category", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 36 } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "subcategory", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 36 } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "label", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "consentState", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "submitter", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "sessionId", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "geography", "required": false }, { "schema": { "type": "array", "items": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "implied", "user_click" ] } }, { "type": "string", "maxLength": 36 } ] } }, "in": "query", "name": "consentAction", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "concordId", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "concordId": { "type": "string", "format": "uuid" }, "consentAction": { "type": "string", "enum": [ "implied", "user_click" ] }, "consentDate": { "type": "string", "format": "date-time" }, "consentState": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "consentType": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ] }, "expirationDate": { "type": "string", "format": "date-time" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "session": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "anyOf": [ { "enum": [ "localhost" ] }, { "type": "string" } ] }, "geography": { "type": "string" }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "submitter": { "type": "string", "format": "uuid" }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" } }, "required": [ "id", "concordId", "consentAction", "consentDate", "consentState", "expirationDate" ], "additionalProperties": false } } }, "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}/consent-events/export": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_consent_events_export", "summary": "Export consent events", "tags": [ "Consent Events" ], "description": "Starts a background export of consent events as a CSV or JSON document. Returns the export document immediately, tagged `export-pending`; poll it until an asset appears (ready) or it carries the `export-failed` tag.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "startDate": { "type": "string", "format": "date-time" }, "endDate": { "type": "string", "format": "date-time" }, "projectId": { "type": "string", "format": "uuid" }, "format": { "type": "string", "enum": [ "csv", "json" ] } }, "required": [ "startDate", "endDate", "format" ], "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": {}, "additionalProperties": true } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/data-system-attributes/{dataSystemAttributeId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_data_system_attributes_datasystemattributeid", "summary": "Delete data system attribute", "tags": [ "Data Systems" ], "description": "Deletes a data system attribute.", "parameters": [ { "schema": { "type": "string", "enum": [ "article9Conditions", "contacts", "dataCategories", "destinations", "legitimateInterests", "legalBases", "origins", "processingActivities", "processingPurposes", "relationships", "securityMeasures", "dataSubjects" ] }, "in": "query", "name": "attributeName", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "dataSystemAttributeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "contactType": { "oneOf": [ { "type": "object" } ] }, "email": { "type": "string", "format": "email", "maxLength": 256 }, "phoneNumber": { "type": "string", "maxLength": 256 }, "legalBasisType": { "oneOf": [ { "type": "string" } ] }, "readOnly": { "type": "boolean", "default": false }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "vendorIds": { "type": "array", "items": { "type": "string" } }, "globalDataSystemAttributeId": { "type": "string", "format": "uuid" }, "globalAttribute": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "oneOf": [ { "type": "string" } ] }, "legalBasisType": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "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" ] } } } } } }, "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_data_system_attributes_datasystemattributeid", "summary": "Update data system attribute", "tags": [ "Data Systems" ], "description": "Updates a data system attribute.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dataSystems": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "description": { "oneOf": [ { "type": "string" } ] }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "type": "string", "enum": [ "none", "standard", "sensitive" ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "email": { "type": "string", "format": "email", "maxLength": 256 }, "phoneNumber": { "type": "string", "maxLength": 256 }, "contactType": { "type": "string", "format": "uuid" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "enum": [ "article9Conditions", "contacts", "dataCategories", "destinations", "legitimateInterests", "legalBases", "origins", "processingActivities", "processingPurposes", "relationships", "securityMeasures", "dataSubjects" ] }, "in": "query", "name": "attributeName", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "dataSystemAttributeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "contactType": { "oneOf": [ { "type": "object" } ] }, "email": { "type": "string", "format": "email", "maxLength": 256 }, "phoneNumber": { "type": "string", "maxLength": 256 }, "legalBasisType": { "oneOf": [ { "type": "string" } ] }, "readOnly": { "type": "boolean", "default": false }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "vendorIds": { "type": "array", "items": { "type": "string" } }, "globalDataSystemAttributeId": { "type": "string", "format": "uuid" }, "globalAttribute": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "oneOf": [ { "type": "string" } ] }, "legalBasisType": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "projects": { "type": "array", "items": {} } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "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}/data-system-attributes": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_data_system_attributes", "summary": "Get data system attributes", "tags": [ "Data Systems" ], "description": "Gets the data system attributes for an organization.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "none", "standard", "sensitive" ] }, { "type": "array", "items": { "type": "string", "enum": [ "none", "standard", "sensitive" ] } } ] }, "in": "query", "name": "pIIType", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "active", "archived", "test", "all" ] }, { "type": "array", "items": { "type": "string", "enum": [ "active", "archived", "test" ] } } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "enum": [ "article9Conditions", "contacts", "dataCategories", "destinations", "legitimateInterests", "legalBases", "origins", "processingPurposes", "relationships", "securityMeasures", "dataSubjects" ] }, "in": "query", "name": "attributeName", "required": true }, { "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "contactType": { "oneOf": [ { "type": "object" } ] }, "email": { "type": "string", "format": "email", "maxLength": 256 }, "phoneNumber": { "type": "string", "maxLength": 256 }, "legalBasisType": { "oneOf": [ { "type": "string" } ] }, "readOnly": { "type": "boolean", "default": false }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "vendorIds": { "type": "array", "items": { "type": "string" } }, "globalDataSystemAttributeId": { "type": "string", "format": "uuid" }, "globalAttribute": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "oneOf": [ { "type": "string" } ] }, "legalBasisType": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status" ], "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_privacy_v1_organizations_organizationid_data_system_attributes", "summary": "Create data system attribute", "tags": [ "Data Systems" ], "description": "Creates a new data system attribute.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "description": { "type": "string", "maxLength": 1024 }, "dataSystems": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "pIIType": { "type": "string", "default": "none", "enum": [ "none", "standard", "sensitive" ] }, "email": { "type": "string", "format": "email", "maxLength": 256 }, "phoneNumber": { "type": "string", "maxLength": 256 }, "contactType": { "type": "string", "format": "uuid" } }, "required": [ "name", "status" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "enum": [ "article9Conditions", "contacts", "dataCategories", "destinations", "legitimateInterests", "legalBases", "origins", "processingActivities", "processingPurposes", "relationships", "securityMeasures", "dataSubjects" ] }, "in": "query", "name": "attributeName", "required": true }, { "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" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "contactType": { "oneOf": [ { "type": "object" } ] }, "email": { "type": "string", "format": "email", "maxLength": 256 }, "phoneNumber": { "type": "string", "maxLength": 256 }, "legalBasisType": { "oneOf": [ { "type": "string" } ] }, "readOnly": { "type": "boolean", "default": false }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "vendorIds": { "type": "array", "items": { "type": "string" } }, "globalDataSystemAttributeId": { "type": "string", "format": "uuid" }, "globalAttribute": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "oneOf": [ { "type": "string" } ] }, "legalBasisType": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "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}/data-systems/{dataSystemId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_data_systems_datasystemid", "summary": "Delete data system", "tags": [ "Data Systems" ], "description": "Deletes a data system.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "dataSystemId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "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" ] } } } } } }, "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_data_systems_datasystemid", "summary": "Update data system", "tags": [ "Data Systems" ], "description": "Updates a data system.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "dataLocations": { "type": "array", "items": { "type": "string" } }, "crossBorder": { "type": "boolean" }, "retention": { "type": "string", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDestinations": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemOrigins": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "processingActivities": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemProcessingPurposes": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemRelationship": { "type": "string", "format": "uuid" }, "dataSystemSecurityMeasures": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataCategories": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataSubjects": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "icon": { "type": "string" }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "catalogSlug": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "dataSystemId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "projects": { "type": "array", "items": {} } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "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}/data-systems": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_data_systems", "summary": "Get data systems", "tags": [ "Data Systems" ], "description": "Gets the data systems for an organization.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "crossBorder", "required": false }, { "schema": { "type": "string", "format": "duration" }, "in": "query", "name": "retention", "required": false }, { "schema": { "type": "string", "maxLength": 1024 }, "in": "query", "name": "additionalNotes", "required": false }, { "schema": { "default": "active", "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "active", "archived", "test" ] } }, { "type": "string", "enum": [ "active", "archived", "test" ] } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemDestination", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemContact", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemDataCategory", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemDataSubject", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemOrigin", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "processingActivity", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemProcessingPurpose", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemRelationship", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "dataSystemSecurityMeasure", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string", "maxLength": 256 } ] }, "in": "query", "name": "globalDataSystemId", "required": false }, { "schema": { "type": "string", "enum": [ "dateCreated", "dateUpdated", "id", "name", "crossBorder", "retention", "globalDataSystemId", "status", "dataSystemRelationship" ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "status" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_data_systems", "summary": "Create data system", "tags": [ "Data Systems" ], "description": "Creates a new data system.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "type": "string", "maxLength": 1024 }, "description": { "type": "string", "maxLength": 1024 }, "dataSystemContacts": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDestinations": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemOrigins": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "processingActivities": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemProcessingPurposes": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemRelationship": { "type": "string", "format": "uuid" }, "dataSystemSecurityMeasures": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataCategories": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataSubjects": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "icon": { "type": "string" } }, "required": [ "name", "status" ], "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" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "linkedVendor": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "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}/data-system-connections": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_data_system_connections", "summary": "Create a data flow between two data systems", "tags": [ "Data System Connections" ], "description": "Creates a directional data flow (connection) between two data systems.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dataSystem1": { "type": "string", "format": "uuid" }, "dataSystem2": { "type": "string", "format": "uuid" }, "direction": { "type": "string", "enum": [ "system1-to-system2", "system2-to-system1", "bidirectional" ] }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "transferMechanism": { "oneOf": [ { "type": "string" } ] } }, "required": [ "dataSystem1", "dataSystem2", "direction" ], "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" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "dataSystem1": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "icon": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "dataSystem2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "icon": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "pairKey": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "direction": { "type": "string", "enum": [ "system1-to-system2", "system2-to-system1", "bidirectional" ] }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "transferMechanism": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "dataSystem1", "dataSystem2", "direction" ], "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_privacy_v1_organizations_organizationid_data_system_connections", "summary": "List data flows (optionally for one data system)", "tags": [ "Data System Connections" ], "description": "Lists data flows for the organization, optionally filtered to one data system.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "dataSystemId", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "dataSystem1": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "icon": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "dataSystem2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "icon": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "pairKey": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "direction": { "type": "string", "enum": [ "system1-to-system2", "system2-to-system1", "bidirectional" ] }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "transferMechanism": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "dataSystem1", "dataSystem2", "direction" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/data-system-connections/{dataSystemConnectionId}": { "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_data_system_connections_datasystemconnectionid", "summary": "Update a data flow", "tags": [ "Data System Connections" ], "description": "Updates a data flow (direction, data categories, or transfer mechanism).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "direction": { "type": "string", "enum": [ "system1-to-system2", "system2-to-system1", "bidirectional" ] }, "dataSystemDataCategories": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "transferMechanism": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "dataSystemConnectionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "dataSystem1": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "icon": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "dataSystem2": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "icon": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false }, "pairKey": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "direction": { "type": "string", "enum": [ "system1-to-system2", "system2-to-system1", "bidirectional" ] }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "transferMechanism": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "dataSystem1", "dataSystem2", "direction" ], "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_privacy_v1_organizations_organizationid_data_system_connections_datasystemconnectionid", "summary": "Delete a data flow", "tags": [ "Data System Connections" ], "description": "Deletes a data flow (connection) between two data systems.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "dataSystemConnectionId", "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}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid", "summary": "Delete organization by ID", "tags": [ "Organizations" ], "description": "Updates 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": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "defaultProjectId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingEmails": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingPhoneNumber": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingAddress": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "subscription": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "stripe": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "hashSalt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "consentSyncProjectIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "consentSyncScope": { "type": "string", "default": "all", "enum": [ "all", "opt_out_rights" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "primaryDomain": { "type": "string" }, "slug": { "type": "string", "maxLength": 256 }, "projects": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } }, "status": { "type": "string", "default": "active", "enum": [ "active", "suspended", "disabled", "deleted" ] }, "statusDate": { "type": "integer" }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "features": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "default": { "domains": { "licensed": 0, "used": 0, "available": 0 }, "policies": { "licensed": 0, "used": 0, "available": 0 }, "users": { "licensed": 0, "used": 0, "available": 0 } }, "properties": { "domains": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "users": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 }, "sources": { "type": "object", "properties": { "privacyPlan": { "type": "integer", "minimum": 0 }, "trustPlan": { "type": "integer", "minimum": 0 }, "base": { "type": "integer", "minimum": 0 }, "privacyAddon": { "type": "integer", "minimum": 0 }, "trustAddon": { "type": "integer", "minimum": 0 } }, "required": [ "privacyPlan", "trustPlan", "base", "privacyAddon", "trustAddon" ], "additionalProperties": false } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "policies": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false } }, "required": [ "domains", "users", "policies" ], "additionalProperties": false } ] } }, "required": [ "name", "dateCreated", "dateUpdated", "primaryDomain", "slug", "statusDate", "statusFlags" ], "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_privacy_v1_organizations_organizationid", "summary": "Get organization by ID", "tags": [ "Organizations" ], "description": "Gets the details 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": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "defaultProjectId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingEmails": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingPhoneNumber": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingAddress": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "subscription": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "stripe": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "hashSalt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "consentSyncProjectIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "consentSyncScope": { "type": "string", "default": "all", "enum": [ "all", "opt_out_rights" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "primaryDomain": { "type": "string" }, "slug": { "type": "string", "maxLength": 256 }, "projects": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } }, "status": { "type": "string", "default": "active", "enum": [ "active", "suspended", "disabled", "deleted" ] }, "statusDate": { "type": "integer" }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "features": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "default": { "domains": { "licensed": 0, "used": 0, "available": 0 }, "policies": { "licensed": 0, "used": 0, "available": 0 }, "users": { "licensed": 0, "used": 0, "available": 0 } }, "properties": { "domains": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "users": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 }, "sources": { "type": "object", "properties": { "privacyPlan": { "type": "integer", "minimum": 0 }, "trustPlan": { "type": "integer", "minimum": 0 }, "base": { "type": "integer", "minimum": 0 }, "privacyAddon": { "type": "integer", "minimum": 0 }, "trustAddon": { "type": "integer", "minimum": 0 } }, "required": [ "privacyPlan", "trustPlan", "base", "privacyAddon", "trustAddon" ], "additionalProperties": false } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "policies": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false } }, "required": [ "domains", "users", "policies" ], "additionalProperties": false } ] } }, "required": [ "name", "dateCreated", "dateUpdated", "primaryDomain", "slug", "statusDate", "statusFlags" ], "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_privacy_v1_organizations_organizationid", "summary": "Update organization by ID", "tags": [ "Organizations" ], "description": "Updates an organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationSlug": { "type": "string", "maxLength": 256 }, "primaryDomain": { "type": "string" }, "consentSyncProjectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "consentSyncScope": { "type": "string", "enum": [ "all", "opt_out_rights" ] } }, "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": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "defaultProjectId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingEmails": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingPhoneNumber": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingAddress": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "subscription": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "stripe": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "hashSalt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "consentSyncProjectIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "consentSyncScope": { "type": "string", "default": "all", "enum": [ "all", "opt_out_rights" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "primaryDomain": { "type": "string" }, "slug": { "type": "string", "maxLength": 256 }, "projects": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } }, "status": { "type": "string", "default": "active", "enum": [ "active", "suspended", "disabled", "deleted" ] }, "statusDate": { "type": "integer" }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "features": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "default": { "domains": { "licensed": 0, "used": 0, "available": 0 }, "policies": { "licensed": 0, "used": 0, "available": 0 }, "users": { "licensed": 0, "used": 0, "available": 0 } }, "properties": { "domains": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "users": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 }, "sources": { "type": "object", "properties": { "privacyPlan": { "type": "integer", "minimum": 0 }, "trustPlan": { "type": "integer", "minimum": 0 }, "base": { "type": "integer", "minimum": 0 }, "privacyAddon": { "type": "integer", "minimum": 0 }, "trustAddon": { "type": "integer", "minimum": 0 } }, "required": [ "privacyPlan", "trustPlan", "base", "privacyAddon", "trustAddon" ], "additionalProperties": false } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "policies": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false } }, "required": [ "domains", "users", "policies" ], "additionalProperties": false } ] } }, "required": [ "name", "dateCreated", "dateUpdated", "primaryDomain", "slug", "statusDate", "statusFlags" ], "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}/emails/{emailId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_emails_emailid", "summary": "Delete send from email", "tags": [ "Emails" ], "description": "Deletes a send from email.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "emailId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "dateCreated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "enum": [ "default" ] }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "status": { "enum": [ "verified" ] } }, "required": [ "dateCreated", "email", "id", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "organizationId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "identityType": { "type": "string", "enum": [ "address", "domain" ] }, "domain": { "type": "string", "format": "hostname" }, "dkimTokens": { "type": "array", "items": { "type": "string" } }, "dkimStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED" ] }, "mailFromDomain": { "type": "string", "format": "hostname" }, "mailFromStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE" ] }, "lastVerificationCheckAt": { "type": "integer" }, "sesRegion": { "type": "string" } }, "required": [ "dateCreated", "dateUpdated", "email", "id", "organizationId", "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" ] } } } } } }, "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_emails_emailid", "summary": "Update send from email", "tags": [ "Emails" ], "description": "Updates a send from email.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "emailId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "dateCreated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "enum": [ "default" ] }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "status": { "enum": [ "verified" ] } }, "required": [ "dateCreated", "email", "id", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "organizationId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "identityType": { "type": "string", "enum": [ "address", "domain" ] }, "domain": { "type": "string", "format": "hostname" }, "dkimTokens": { "type": "array", "items": { "type": "string" } }, "dkimStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED" ] }, "mailFromDomain": { "type": "string", "format": "hostname" }, "mailFromStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE" ] }, "lastVerificationCheckAt": { "type": "integer" }, "sesRegion": { "type": "string" } }, "required": [ "dateCreated", "dateUpdated", "email", "id", "organizationId", "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}/emails": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_emails", "summary": "Get send from emails", "tags": [ "Emails" ], "description": "Gets the send from emails for an organization.", "parameters": [ { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "email", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "verified", "pending" ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "dateCreated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "enum": [ "default" ] }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "status": { "enum": [ "verified" ] } }, "required": [ "dateCreated", "email", "id", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "organizationId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "identityType": { "type": "string", "enum": [ "address", "domain" ] }, "domain": { "type": "string", "format": "hostname" }, "dkimTokens": { "type": "array", "items": { "type": "string" } }, "dkimStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED" ] }, "mailFromDomain": { "type": "string", "format": "hostname" }, "mailFromStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE" ] }, "lastVerificationCheckAt": { "type": "integer" }, "sesRegion": { "type": "string" } }, "required": [ "dateCreated", "dateUpdated", "email", "id", "organizationId", "status" ], "additionalProperties": false } ] } } }, "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_privacy_v1_organizations_organizationid_emails", "summary": "Create send from email", "tags": [ "Emails" ], "description": "Creates a new send-from identity. Defaults to a per-address identity (sends a SES verification email to the recipient); pass `identityType: \"domain\"` with `domain: \"\"` to provision a per-domain SES identity (returns DKIM + MAIL FROM DNS records for the customer to publish at their DNS provider).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "identityType": { "type": "string", "default": "address", "enum": [ "address", "domain" ] }, "email": { "type": "string", "format": "email" }, "domain": { "type": "string", "format": "hostname" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "dateCreated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "enum": [ "default" ] }, "name": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "status": { "enum": [ "verified" ] } }, "required": [ "dateCreated", "email", "id", "status" ], "additionalProperties": false }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "projects": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "organizationId": { "type": "string", "format": "uuid" }, "status": { "type": "string", "enum": [ "pending", "verified" ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "identityType": { "type": "string", "enum": [ "address", "domain" ] }, "domain": { "type": "string", "format": "hostname" }, "dkimTokens": { "type": "array", "items": { "type": "string" } }, "dkimStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE", "NOT_STARTED" ] }, "mailFromDomain": { "type": "string", "format": "hostname" }, "mailFromStatus": { "type": "string", "enum": [ "PENDING", "SUCCESS", "FAILED", "TEMPORARY_FAILURE" ] }, "lastVerificationCheckAt": { "type": "integer" }, "sesRegion": { "type": "string" } }, "required": [ "dateCreated", "dateUpdated", "email", "id", "organizationId", "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": { "get": { "operationId": "get_privacy_v1_organizations", "summary": "Get organizations", "tags": [ "Organizations" ], "description": "Gets the organizations that you have access to.", "parameters": [ { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "primaryDomain", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "active", "suspended", "disabled", "deleted" ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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 } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "defaultProjectId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingEmails": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingPhoneNumber": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingAddress": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "subscription": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "stripe": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "hashSalt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "consentSyncProjectIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "consentSyncScope": { "type": "string", "default": "all", "enum": [ "all", "opt_out_rights" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "primaryDomain": { "type": "string" }, "slug": { "type": "string", "maxLength": 256 }, "projects": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } }, "status": { "type": "string", "default": "active", "enum": [ "active", "suspended", "disabled", "deleted" ] }, "statusDate": { "type": "integer" }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "features": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "default": { "domains": { "licensed": 0, "used": 0, "available": 0 }, "policies": { "licensed": 0, "used": 0, "available": 0 }, "users": { "licensed": 0, "used": 0, "available": 0 } }, "properties": { "domains": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "users": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 }, "sources": { "type": "object", "properties": { "privacyPlan": { "type": "integer", "minimum": 0 }, "trustPlan": { "type": "integer", "minimum": 0 }, "base": { "type": "integer", "minimum": 0 }, "privacyAddon": { "type": "integer", "minimum": 0 }, "trustAddon": { "type": "integer", "minimum": 0 } }, "required": [ "privacyPlan", "trustPlan", "base", "privacyAddon", "trustAddon" ], "additionalProperties": false } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "policies": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false } }, "required": [ "domains", "users", "policies" ], "additionalProperties": false } ] } }, "required": [ "name", "dateCreated", "dateUpdated", "primaryDomain", "slug", "statusDate", "statusFlags" ], "additionalProperties": false } } }, "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_privacy_v1_organizations", "summary": "Create organization", "tags": [ "Organizations" ], "description": "Creates a new organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "description": "The name of the new organization", "minLength": 2, "maxLength": 1024 }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "logspotAnonymousId": { "type": "string", "maxLength": 64 }, "regionTemplate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "oneOf": [ { "type": "string" } ] }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "hideUnusedCategories": { "type": "boolean" }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number" }, "gcm": { "type": "string", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string" }, "impliedConsentDelay": { "type": "number", "minimum": 0, "maximum": 30 }, "microsoftUET": { "type": "string", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean" }, "wordpress": { "type": "boolean" }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "dataCategories": { "type": "array", "items": { "type": "number" } } }, "required": [ "vendorId", "framework" ], "additionalProperties": false } }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" } }, "additionalProperties": false }, "consentMode": { "oneOf": [ { "enum": [ "express" ] }, { "type": "string", "enum": [ "implied", "express" ] } ] }, "privacyMode": { "oneOf": [ { "enum": [ "categories_only" ] }, { "oneOf": [ { "type": "string", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "layout": { "type": "string", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "oneOf": [ { "type": "string" } ] }, "title": { "type": "boolean" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean" }, "closeButton": { "type": "boolean" }, "closeButtonConsentBehavior": { "type": "string", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] }, "customizeButton": { "type": "boolean" }, "doNotSellSwitch": { "type": "boolean" }, "policySelections": { "type": "object", "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean" }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] }, "limitPii": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] } }, "additionalProperties": false }, "crossSiteTracking": { "type": "boolean" }, "crossDeviceConsent": { "type": "boolean" }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "circleOffsetX": { "type": "string" }, "circleOffsetY": { "type": "string" }, "tabOffsetY": { "type": "string" }, "position": { "type": "string" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean" }, "consentHistoryMode": { "type": "string", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean" }, "dsrFormMode": { "type": "string", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean" }, "doNotSellRequests": { "type": "boolean" }, "position": { "type": "string" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean" }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "defaultLanguage": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "primaryDomain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "organizationSlug": { "type": "string", "maxLength": 256 }, "privacyPolicyUrl": { "type": "string" }, "termsOfServiceUrl": { "type": "string" }, "subscription": { "type": "object", "properties": { "interval": { "type": "string", "enum": [ "month", "year" ] }, "plan": { "type": "string", "enum": [ "free", "lite", "essentials", "pro", "premium", "enterprise", "appSumoTierOne", "appSumoTierTwo", "appSumoTierThree", "appSumoTierFour", "appSumoTierFive", "appSumoTierSix", "appSumoTierSeven", "appSumoTierEight", "appSumoTierNine", "appSumoTierTen", "appSumoTierEleven", "appSumoTierTwelve", "appSumoTierThirteen", "appSumoTierFourteen", "appSumoTierFifteen", "appSumoTierSixteen", "appSumoTierSeventeen", "appSumoTierEighteen", "appSumoTierNineteen", "appSumoTierTwenty" ] }, "sessionsBand": { "type": "integer", "minimum": 0 }, "addons": { "type": "object", "default": { "domains": 0, "users": 0 }, "properties": { "domains": { "type": "integer", "default": 0, "minimum": 0 }, "users": { "type": "integer", "default": 0, "minimum": 0 } }, "additionalProperties": false }, "flatAddons": { "type": "object", "properties": { "ropa": { "type": "boolean", "default": false }, "assessments": { "type": "boolean", "default": false } }, "additionalProperties": false }, "collectPayment": { "type": "boolean", "default": true }, "promotionCode": { "type": "string", "maxLength": 64 }, "test": { "type": "boolean", "default": false } }, "required": [ "interval", "plan" ], "additionalProperties": false }, "trustSubscription": { "type": "object", "properties": { "plan": { "type": "string", "enum": [ "free", "pro", "premium" ] }, "externalCompanyLimit": { "type": "integer", "minimum": 0 }, "billingInterval": { "type": "string", "enum": [ "monthly", "annual" ] }, "dataCreditPackId": { "type": "string" }, "trustCenter": { "type": "object", "properties": { "slug": { "type": "string", "maxLength": 63 } }, "required": [ "slug" ], "additionalProperties": false } }, "required": [ "plan", "externalCompanyLimit", "billingInterval" ], "additionalProperties": false }, "payment": { "type": "object", "properties": { "mode": { "enum": [ "setup" ] } }, "required": [ "mode" ], "additionalProperties": false } }, "required": [ "name", "primaryDomain" ], "additionalProperties": false, "anyOf": [ { "required": [ "subscription" ] }, { "required": [ "trustSubscription" ] } ] } } }, "required": true }, "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "defaultProjectId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingEmails": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingPhoneNumber": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "billingAddress": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "subscription": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "hashSalt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "consentSyncProjectIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "consentSyncScope": { "type": "string", "default": "all", "enum": [ "all", "opt_out_rights" ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "primaryDomain": { "type": "string" }, "slug": { "type": "string", "maxLength": 256 }, "projects": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } }, "status": { "type": "string", "default": "active", "enum": [ "active", "suspended", "disabled", "deleted" ] }, "statusDate": { "type": "integer" }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" } }, "additionalProperties": false }, "features": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "default": { "domains": { "licensed": 0, "used": 0, "available": 0 }, "policies": { "licensed": 0, "used": 0, "available": 0 }, "users": { "licensed": 0, "used": 0, "available": 0 } }, "properties": { "domains": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "users": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 }, "sources": { "type": "object", "properties": { "privacyPlan": { "type": "integer", "minimum": 0 }, "trustPlan": { "type": "integer", "minimum": 0 }, "base": { "type": "integer", "minimum": 0 }, "privacyAddon": { "type": "integer", "minimum": 0 }, "trustAddon": { "type": "integer", "minimum": 0 } }, "required": [ "privacyPlan", "trustPlan", "base", "privacyAddon", "trustAddon" ], "additionalProperties": false } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false }, "policies": { "type": "object", "default": { "licensed": 0, "used": 0, "available": 0 }, "properties": { "licensed": { "type": "integer", "default": 0, "minimum": -1 }, "used": { "type": "integer", "default": 0, "minimum": 0 }, "available": { "type": "integer", "default": 0, "minimum": 0 } }, "required": [ "licensed", "used", "available" ], "additionalProperties": false } }, "required": [ "domains", "users", "policies" ], "additionalProperties": false } ] }, "stripe": { "type": "object", "properties": { "privacy": { "type": "object", "properties": { "customerId": { "type": "string" }, "subscriptionId": { "type": "string" }, "clientSecret": { "type": "string" } }, "additionalProperties": false }, "trust": { "type": "object", "properties": { "customerId": { "type": "string" }, "subscriptionId": { "type": "string" }, "clientSecret": { "type": "string" } }, "additionalProperties": false }, "privacyError": { "type": "string" }, "trustError": { "type": "string" }, "setupIntentClientSecret": { "type": "string" }, "customerId": { "type": "string" } }, "additionalProperties": false } }, "required": [ "name", "dateCreated", "dateUpdated", "primaryDomain", "slug", "statusDate", "statusFlags" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}/languages": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_languages", "summary": "Enables or disables the multi-language support for the given organization, project, and region IDs.", "tags": [ "Languages" ], "description": "Enables or disables the multi-language support and translates English language settings to the preset target languages.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": {}, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "slug": { "type": "string", "maxLength": 256 } }, "required": [ "name", "regions", "settings", "id", "projectId", "dateCreated", "dateUpdated", "slug" ], "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_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_languages", "summary": "Get languages", "tags": [ "Languages" ], "description": "Gets languages for a region.", "parameters": [ { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regionId": { "type": "string", "format": "uuid" }, "consentBanner": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "link": { "oneOf": [ { "type": "string" } ] }, "privacyPolicyLink": { "oneOf": [ { "type": "string" } ] }, "termsOfServiceLink": { "oneOf": [ { "type": "string" } ] }, "cookiePolicyLink": { "oneOf": [ { "type": "string" } ] }, "dataProtectionAgreementLink": { "oneOf": [ { "type": "string" } ] }, "acceptButton": { "oneOf": [ { "type": "string" } ] }, "denyButton": { "oneOf": [ { "type": "string" } ] }, "customizeButton": { "oneOf": [ { "type": "string" } ] }, "customizeLink": { "oneOf": [ { "type": "string" } ] }, "doNotSellLink": { "oneOf": [ { "type": "string" } ] }, "gcmLink": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "floatingButton": { "type": "object", "properties": { "tab": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "acceptButton": { "oneOf": [ { "type": "string" } ] }, "acceptText": { "oneOf": [ { "type": "string" } ] }, "fallbackText": { "oneOf": [ { "type": "string" } ] }, "dnsText": { "oneOf": [ { "type": "string" } ] }, "dnsAcceptButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "tabTitle": { "oneOf": [ { "type": "string" } ] }, "consentHistory": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "states": { "type": "object", "properties": { "accepted": { "oneOf": [ { "type": "string" } ] }, "declined": { "oneOf": [ { "type": "string" } ] }, "implied": { "oneOf": [ { "type": "string" } ] }, "enabled": { "oneOf": [ { "type": "string" } ] }, "disabled": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "vendors": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "additionalDetailsButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "consentCategory": { "type": "object", "properties": { "strictlyNecessary": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "analytics": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "functional": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "marketing": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "unclassified": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "limitPiiUse": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSell": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyPolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "termsOfService": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "cookiePolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "dataProtectionAgreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "agreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "disclosures": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "consentSettings": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "confirmButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyRequests": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "optionsTitle": { "oneOf": [ { "type": "string" } ] }, "optionsButton": { "oneOf": [ { "type": "string" } ] }, "changeRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "deleteRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSellRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "viewRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "required": [ "changeRequest", "deleteRequest", "doNotSellRequest", "viewRequest" ], "additionalProperties": false } }, "required": [ "consentHistory", "disclosures", "privacyRequests" ], "additionalProperties": false }, "translationSource": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "name", "regionId", "consentBanner", "floatingButton", "placeholders", "privacyCenter", "id", "projectId", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}/languages/{languageId}": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_languages_languageid", "summary": "Get language", "tags": [ "Languages" ], "description": "Gets a language.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "languageId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regionId": { "type": "string", "format": "uuid" }, "consentBanner": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "link": { "oneOf": [ { "type": "string" } ] }, "privacyPolicyLink": { "oneOf": [ { "type": "string" } ] }, "termsOfServiceLink": { "oneOf": [ { "type": "string" } ] }, "cookiePolicyLink": { "oneOf": [ { "type": "string" } ] }, "dataProtectionAgreementLink": { "oneOf": [ { "type": "string" } ] }, "acceptButton": { "oneOf": [ { "type": "string" } ] }, "denyButton": { "oneOf": [ { "type": "string" } ] }, "customizeButton": { "oneOf": [ { "type": "string" } ] }, "customizeLink": { "oneOf": [ { "type": "string" } ] }, "doNotSellLink": { "oneOf": [ { "type": "string" } ] }, "gcmLink": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "floatingButton": { "type": "object", "properties": { "tab": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "acceptButton": { "oneOf": [ { "type": "string" } ] }, "acceptText": { "oneOf": [ { "type": "string" } ] }, "fallbackText": { "oneOf": [ { "type": "string" } ] }, "dnsText": { "oneOf": [ { "type": "string" } ] }, "dnsAcceptButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "tabTitle": { "oneOf": [ { "type": "string" } ] }, "consentHistory": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "states": { "type": "object", "properties": { "accepted": { "oneOf": [ { "type": "string" } ] }, "declined": { "oneOf": [ { "type": "string" } ] }, "implied": { "oneOf": [ { "type": "string" } ] }, "enabled": { "oneOf": [ { "type": "string" } ] }, "disabled": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "vendors": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "additionalDetailsButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "consentCategory": { "type": "object", "properties": { "strictlyNecessary": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "analytics": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "functional": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "marketing": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "unclassified": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "limitPiiUse": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSell": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyPolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "termsOfService": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "cookiePolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "dataProtectionAgreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "agreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "disclosures": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "consentSettings": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "confirmButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyRequests": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "optionsTitle": { "oneOf": [ { "type": "string" } ] }, "optionsButton": { "oneOf": [ { "type": "string" } ] }, "changeRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "deleteRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSellRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "viewRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "required": [ "changeRequest", "deleteRequest", "doNotSellRequest", "viewRequest" ], "additionalProperties": false } }, "required": [ "consentHistory", "disclosures", "privacyRequests" ], "additionalProperties": false }, "translationSource": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "name", "regionId", "consentBanner", "floatingButton", "placeholders", "privacyCenter", "id", "projectId", "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_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_languages_languageid", "summary": "Update language", "tags": [ "Languages" ], "description": "Updates an existing language.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "consentBanner": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "link": { "oneOf": [ { "type": "string" } ] }, "privacyPolicyLink": { "oneOf": [ { "type": "string" } ] }, "termsOfServiceLink": { "oneOf": [ { "type": "string" } ] }, "cookiePolicyLink": { "oneOf": [ { "type": "string" } ] }, "dataProtectionAgreementLink": { "oneOf": [ { "type": "string" } ] }, "acceptButton": { "oneOf": [ { "type": "string" } ] }, "denyButton": { "oneOf": [ { "type": "string" } ] }, "customizeButton": { "oneOf": [ { "type": "string" } ] }, "customizeLink": { "oneOf": [ { "type": "string" } ] }, "doNotSellLink": { "oneOf": [ { "type": "string" } ] }, "gcmLink": { "oneOf": [ { "type": "string" } ] }, "tcfTitle": { "oneOf": [ { "type": "string" } ] }, "tcfText": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "floatingButton": { "type": "object", "properties": { "tab": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "acceptButton": { "oneOf": [ { "type": "string" } ] }, "acceptText": { "oneOf": [ { "type": "string" } ] }, "fallbackText": { "oneOf": [ { "type": "string" } ] }, "dnsText": { "oneOf": [ { "type": "string" } ] }, "dnsAcceptButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "tabTitle": { "oneOf": [ { "type": "string" } ] }, "consentHistory": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "states": { "type": "object", "properties": { "accepted": { "oneOf": [ { "type": "string" } ] }, "declined": { "oneOf": [ { "type": "string" } ] }, "implied": { "oneOf": [ { "type": "string" } ] }, "enabled": { "oneOf": [ { "type": "string" } ] }, "disabled": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "vendors": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "additionalDetailsButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "disclosures": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyRequests": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "optionsTitle": { "oneOf": [ { "type": "string" } ] }, "optionsButton": { "oneOf": [ { "type": "string" } ] }, "changeRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "deleteRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSellRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "viewRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "consentCategory": { "type": "object", "properties": { "strictlyNecessary": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "analytics": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "functional": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "marketing": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "unclassified": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "limitPiiUse": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSell": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyPolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "termsOfService": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "cookiePolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "dataProtectionAgreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "agreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "consentSettings": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "confirmButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "languageId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regionId": { "type": "string", "format": "uuid" }, "consentBanner": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "link": { "oneOf": [ { "type": "string" } ] }, "privacyPolicyLink": { "oneOf": [ { "type": "string" } ] }, "termsOfServiceLink": { "oneOf": [ { "type": "string" } ] }, "cookiePolicyLink": { "oneOf": [ { "type": "string" } ] }, "dataProtectionAgreementLink": { "oneOf": [ { "type": "string" } ] }, "acceptButton": { "oneOf": [ { "type": "string" } ] }, "denyButton": { "oneOf": [ { "type": "string" } ] }, "customizeButton": { "oneOf": [ { "type": "string" } ] }, "customizeLink": { "oneOf": [ { "type": "string" } ] }, "doNotSellLink": { "oneOf": [ { "type": "string" } ] }, "gcmLink": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "floatingButton": { "type": "object", "properties": { "tab": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "acceptButton": { "oneOf": [ { "type": "string" } ] }, "acceptText": { "oneOf": [ { "type": "string" } ] }, "fallbackText": { "oneOf": [ { "type": "string" } ] }, "dnsText": { "oneOf": [ { "type": "string" } ] }, "dnsAcceptButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "tabTitle": { "oneOf": [ { "type": "string" } ] }, "consentHistory": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "states": { "type": "object", "properties": { "accepted": { "oneOf": [ { "type": "string" } ] }, "declined": { "oneOf": [ { "type": "string" } ] }, "implied": { "oneOf": [ { "type": "string" } ] }, "enabled": { "oneOf": [ { "type": "string" } ] }, "disabled": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "vendors": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "additionalDetailsButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "consentCategory": { "type": "object", "properties": { "strictlyNecessary": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "analytics": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "functional": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "marketing": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "unclassified": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "limitPiiUse": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSell": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyPolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "termsOfService": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "cookiePolicy": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "dataProtectionAgreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "agreement": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "disclosures": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "consentSettings": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "confirmButton": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "privacyRequests": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] }, "optionsTitle": { "oneOf": [ { "type": "string" } ] }, "optionsButton": { "oneOf": [ { "type": "string" } ] }, "changeRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "deleteRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "doNotSellRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "viewRequest": { "type": "object", "properties": { "title": { "oneOf": [ { "type": "string" } ] }, "text": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "required": [ "changeRequest", "deleteRequest", "doNotSellRequest", "viewRequest" ], "additionalProperties": false } }, "required": [ "consentHistory", "disclosures", "privacyRequests" ], "additionalProperties": false }, "translationSource": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "name", "regionId", "consentBanner", "floatingButton", "placeholders", "privacyCenter", "id", "projectId", "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}/mcp-tool-access": { "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_mcp_tool_access", "summary": "Set MCP tool access", "tags": [ "Organizations" ], "description": "Enables or disables a single MCP write tool, or all MCP writes, for the organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "enum": [ "writes", "create_task", "create_privacy_request", "update_privacy_request", "create_data_system", "update_data_system", "classify_tracker", "run_tracker_scan", "transition_task", "assign_task", "create_risk", "create_vendor", "update_vendor", "open_vendor_review", "add_control_evidence" ] }, "enabled": { "type": "boolean" } }, "required": [ "target", "enabled" ] } } }, "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": { "mcpWritesEnabled": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "setByUserId": { "type": "string" }, "setAt": { "type": "string" } }, "required": [ "enabled", "setByUserId", "setAt" ], "additionalProperties": false }, "mcpWriteTools": { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "setByUserId": { "type": "string" }, "setAt": { "type": "string" } }, "required": [ "enabled", "setByUserId", "setAt" ], "additionalProperties": false } } }, "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}/processing-activities/{processingActivityId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_processing_activities_processingactivityid", "summary": "Processing activity", "tags": [ "Processing Activities" ], "description": "Deletes a processing activity.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "processingActivityId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "icon": { "oneOf": [ { "type": "string" } ] }, "legalBasis": { "oneOf": [ { "type": "object" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemSecurityMeasures": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "article9Condition": { "oneOf": [ { "oneOf": [ { "type": "object" } ] }, { "not": {} } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "predefineId": { "oneOf": [ { "type": "string" } ] }, "globalProcessingActivity": { "type": "object", "properties": {}, "additionalProperties": false }, "customized": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "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" ] } } } } } }, "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_processing_activities_processingactivityid", "summary": "Update processing activity", "tags": [ "Processing Activities" ], "description": "Updates a processing activity.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "dataSystems": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "description": { "oneOf": [ { "type": "string" } ] }, "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "legalBasis": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "legitimateInterests": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id" ], "additionalProperties": false }, "dataSystemContacts": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDestinations": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemOrigins": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemProcessingPurposes": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemRelationship": { "type": "string", "format": "uuid" }, "dataSystemSecurityMeasures": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataSubjects": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataCategories": { "type": "array", "items": { "type": "object", "properties": { "dataSystemDataCategoryId": { "type": "string", "format": "uuid" }, "article9ConditionId": { "oneOf": [ { "type": "string" } ] } }, "required": [ "dataSystemDataCategoryId" ], "additionalProperties": false } }, "resetFields": { "type": "array", "items": { "type": "string" } } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "processingActivityId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "icon": { "oneOf": [ { "type": "string" } ] }, "legalBasis": { "oneOf": [ { "type": "object" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemSecurityMeasures": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "article9Condition": { "oneOf": [ { "oneOf": [ { "type": "object" } ] }, { "not": {} } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "predefineId": { "oneOf": [ { "type": "string" } ] }, "globalProcessingActivity": { "type": "object", "properties": {}, "additionalProperties": false }, "customized": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "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}/processing-activities": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_processing_activities", "summary": "Get processing activities", "tags": [ "Processing Activities" ], "description": "Gets the processing activities for an organization.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "active", "archived", "test", "all" ] }, { "type": "array", "items": { "type": "string", "enum": [ "active", "archived", "test" ] } } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "dateCreated", "dateUpdated", "id", "name", "status" ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "icon": { "oneOf": [ { "type": "string" } ] }, "legalBasis": { "oneOf": [ { "type": "object" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemSecurityMeasures": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "article9Condition": { "oneOf": [ { "oneOf": [ { "type": "object" } ] }, { "not": {} } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "predefineId": { "oneOf": [ { "type": "string" } ] }, "globalProcessingActivity": { "type": "object", "properties": {}, "additionalProperties": false }, "customized": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status" ], "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_privacy_v1_organizations_organizationid_processing_activities", "summary": "Create processing activity", "tags": [ "Processing Activities" ], "description": "Creates a new processing activity.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "icon": { "type": "string", "maxLength": 64 }, "legalBasis": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "legitimateInterests": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id" ], "additionalProperties": false }, "description": { "type": "string", "maxLength": 1024 }, "dataSystemDestinations": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemOrigins": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemProcessingPurposes": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemSecurityMeasures": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystemDataCategories": { "type": "array", "items": { "type": "object", "properties": { "dataSystemDataCategoryId": { "type": "string", "format": "uuid" }, "article9ConditionId": { "oneOf": [ { "type": "string" } ] } }, "required": [ "dataSystemDataCategoryId" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "dataSystems": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "globalProcessingActivity": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false }, "customized": { "type": "boolean" } }, "required": [ "name", "status" ], "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" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "icon": { "oneOf": [ { "type": "string" } ] }, "legalBasis": { "oneOf": [ { "type": "object" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string" }, "projectIds": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemSecurityMeasures": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "article9Condition": { "oneOf": [ { "oneOf": [ { "type": "object" } ] }, { "not": {} } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "predefineId": { "oneOf": [ { "type": "string" } ] }, "globalProcessingActivity": { "type": "object", "properties": {}, "additionalProperties": false }, "customized": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "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}/mapped-global-processing-activities": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_mapped_global_processing_activities", "summary": "Get mapped global processing activities", "tags": [ "Processing Activities" ], "description": "Gets the global processing activities with attributes mapped to organization level ids.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "default": "active", "anyOf": [ { "type": "string", "enum": [ "active", "archived", "test" ] }, { "type": "array", "items": { "type": "string", "enum": [ "active", "archived", "test" ] } } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "enum": [ "dateCreated", "dateUpdated", "id", "name", "status" ] }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "enum": [ "asc", "desc" ] }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "name": { "type": "string", "maxLength": 256 }, "readOnly": { "type": "boolean", "default": false }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "description": { "oneOf": [ { "type": "string" } ] }, "legalBasis": { "oneOf": [ { "type": "object" } ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "icon": { "type": "string" }, "vendorSlug": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "slug": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "status": { "type": "string" } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] }, "article9Condition": { "oneOf": [ { "oneOf": [ { "type": "object" } ] }, { "not": {} } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "predefineId": { "oneOf": [ { "type": "string" } ] }, "icon": { "type": "string", "maxLength": 32 } }, "required": [ "id", "dateCreated", "dateUpdated", "name", "status" ], "additionalProperties": false } } }, "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}/ropa-reports": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_ropa_reports", "summary": "Get ROPA Reports", "tags": [ "ROPA Reports" ], "description": "Gets the ROPA Reports for an organization.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "all", "draft", "archived", "finalized" ] }, { "type": "array", "items": { "type": "string", "enum": [ "draft", "archived", "finalized" ] } } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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_privacy_v1_organizations_organizationid_ropa_reports", "summary": "Create ROPA report", "tags": [ "ROPA Reports" ], "description": "Create a new ROPA report for an organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "processingActivityIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "name" ], "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" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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}/ropa-reports/{reportId}": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_ropa_reports_reportid", "summary": "Get ROPA Report", "tags": [ "ROPA Reports" ], "description": "Gets a ROPA Report.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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_privacy_v1_organizations_organizationid_ropa_reports_reportid", "summary": "Update ROPA report summary", "tags": [ "ROPA Reports" ], "description": "Update the summary content of a ROPA report.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "archived", "draft", "finalized" ] }, "processingActivityIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "editorState": { "type": "string" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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_privacy_v1_organizations_organizationid_ropa_reports_reportid", "summary": "Delete ROPA Report", "tags": [ "ROPA Reports" ], "description": "Deletes a draft ROPA Report. Only reports in draft status can be deleted; finalized reports are archived and retained, never deleted.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "message": { "type": "string" } }, "required": [ "success", "message" ], "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}/ropa-reports/{reportId}/rows/{rowId}": { "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_ropa_reports_reportid_rows_rowid", "summary": "Update a ROPA report row", "tags": [ "ROPA Reports" ], "description": "Update editable Article-30 fields of a single ROPA row (draft only). Sets per-field override flags and appends change-log entries.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "processingPurposes": { "type": "array", "items": { "type": "string" } }, "dataSubjects": { "type": "array", "items": { "type": "string" } }, "dataCategories": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "items": { "type": "string" } }, "dataOrigins": { "type": "array", "items": { "type": "string" } }, "dataDestinations": { "type": "array", "items": { "type": "string" } }, "securityMeasures": { "type": "array", "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string" }, "notes": { "type": "string" }, "excluded": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "rowId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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_privacy_v1_organizations_organizationid_ropa_reports_reportid_rows_rowid", "summary": "Remove a processing activity from a ROPA report", "tags": [ "ROPA Reports" ], "description": "Hard-delete an Article-30 row from a draft report.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true }, { "schema": { "type": "string" }, "in": "path", "name": "rowId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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}/ropa-reports/{reportId}/rows": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_ropa_reports_reportid_rows", "summary": "Add a processing activity to a ROPA report", "tags": [ "ROPA Reports" ], "description": "Seed a new Article-30 row from a processing activity not already in the report (draft only).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "processingActivityId": { "type": "string", "format": "uuid" } }, "required": [ "processingActivityId" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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}/ropa-reports/{reportId}/finalize": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_ropa_reports_reportid_finalize", "summary": "Finalize ROPA report", "tags": [ "ROPA Reports" ], "description": "Finalize a ROPA report: freeze its content, generate a PDF, and store it as a report document.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "description": { "type": "string" }, "status": { "type": "string", "enum": [ "draft", "archived", "finalized" ] }, "editorState": { "type": "string" }, "finalizedState": { "type": "string" }, "rows": { "type": "array", "default": [], "items": { "type": "object", "properties": { "rowId": { "type": "string" }, "processingActivityId": { "type": "string" }, "snapshotAt": { "type": "integer" }, "name": { "type": "string", "default": "" }, "description": { "type": "string", "default": "" }, "processingPurposes": { "type": "array", "default": [], "items": { "type": "string" } }, "dataSubjects": { "type": "array", "default": [], "items": { "type": "string" } }, "dataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "name": { "type": "string" }, "pIIType": { "type": "string", "default": "none" }, "article9ConditionName": { "type": "string" } }, "required": [ "name" ], "additionalProperties": false } }, "legalBasisName": { "type": "string" }, "legitimateInterests": { "type": "array", "default": [], "items": { "type": "string" } }, "dataOrigins": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDestinations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "transferCountries": { "type": "array", "default": [], "items": { "type": "string" } }, "securityMeasures": { "type": "array", "default": [], "items": { "type": "string" } }, "controllerProcessorRole": { "type": "string", "default": "unknown", "enum": [ "controller", "processor", "joint", "unknown" ] }, "retention": { "type": "string", "default": "" }, "notes": { "type": "string", "default": "" }, "excluded": { "type": "boolean", "default": false }, "overrides": { "type": "object", "default": {}, "properties": {}, "additionalProperties": false } }, "required": [ "rowId", "processingActivityId" ], "additionalProperties": false } }, "changes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string" }, "at": { "type": "integer" }, "by": { "type": "string", "format": "uuid" }, "scope": { "type": "string", "enum": [ "summary", "row" ] }, "rowId": { "type": "string" }, "field": { "type": "string" }, "from": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "to": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "note": { "type": "string" } }, "required": [ "id", "at", "scope" ], "additionalProperties": false } }, "processingActivityIds": { "type": "array", "default": [], "items": { "type": "string", "format": "uuid" } }, "source": { "type": "object", "properties": {}, "additionalProperties": true }, "finalizedAt": { "type": "integer" }, "finalizedBy": { "type": "string", "format": "uuid" }, "finalizedDocumentId": { "type": "string", "format": "uuid" }, "finalizedAssetId": { "type": "string", "format": "uuid" }, "createdBy": { "type": "string", "format": "uuid" }, "updatedBy": { "type": "string", "format": "uuid" } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "name", "status", "editorState" ], "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}/ropa-reports/{reportId}/export": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_ropa_reports_reportid_export", "summary": "Export a ROPA report", "tags": [ "ROPA Reports" ], "description": "Renders the report (resolving merge tokens + expanding activity cards) using the same pipeline as finalization, in the requested format. Works for drafts and finalized reports.", "parameters": [ { "schema": { "type": "string", "default": "pdf", "enum": [ "pdf", "html", "md", "txt" ] }, "in": "query", "name": "format", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "reportId", "required": true } ], "responses": { "200": { "description": "Default Response" } } } }, "/organizations/{organizationId}/projects/{projectId}/compliance-requests/{complianceRequestId}/files/{fileName}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests_compliancerequestid_files_filename", "summary": "Delete a compliance request file", "tags": [ "Compliance Requests" ], "description": "Delete a compliance request file from a request.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "complianceRequestId", "required": true }, { "schema": { "type": "string", "maxLength": 255 }, "in": "path", "name": "fileName", "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}/projects/{projectId}/compliance-requests": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests", "summary": "Get project level compliance requests", "tags": [ "Compliance Requests" ], "description": "Gets the compliance requests for a project.", "parameters": [ { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "concordId", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "complianceRequestId", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "endDate", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "geography", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "notes", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "requestDetails", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "resolution", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ] }, { "type": "array", "items": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ] } } ] }, "in": "query", "name": "resolutionStatus", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] } }, { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] } ] }, "in": "query", "name": "request", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] } }, { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "sessionId", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "startDate", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "text", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "userEmail", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "userAgent", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "downloadDate": { "type": "integer" }, "filePurgeDate": { "type": "integer" }, "files": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "apiKey": { "type": "string" }, "date": { "type": "integer" }, "dateCreated": { "type": "integer" }, "details": { "type": "string" }, "event": { "type": "string" }, "fileName": { "type": "string", "maxLength": 255 }, "filePath": { "type": "string" }, "fileSize": { "type": "number", "maximum": 10485760 }, "bucket": { "type": "string" }, "key": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "fileName" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid" }, "acknowledgedDate": { "type": "integer" }, "captureUrl": { "type": "string" }, "concordId": { "type": "string", "format": "uuid" }, "dataSystemTasks": { "type": "array", "items": { "type": "object", "properties": { "dataSystem": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "icon": { "type": "string" }, "dataSystemTypeId": { "type": "string" } }, "additionalProperties": false } ] }, "trustCenter": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "completed": { "type": "boolean" }, "completedAt": { "type": "integer" }, "completedBy": { "type": "string" }, "completionRecord": { "type": "object", "properties": {}, "additionalProperties": true } }, "required": [ "completed" ], "additionalProperties": false } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "domain": { "type": "string" }, "notes": { "type": "string", "maxLength": 2048 }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "preverified": { "type": "boolean" }, "resolution": { "type": "string", "maxLength": 2048 }, "resolutionStatus": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ], "maxLength": 2048 }, "resolvedDate": { "type": "string", "format": "date-time" }, "request": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] }, "requestDate": { "type": "integer" }, "requestDetails": { "type": "string" }, "session": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "anyOf": [ { "enum": [ "localhost" ] }, { "type": "string" } ] }, "geography": { "type": "string" }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] }, "user": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false }, "verifiedDate": { "type": "integer" }, "verificationMethod": { "type": "string", "enum": [ "email", "sms" ] }, "verificationRequestId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "concordId", "requestDate" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests", "summary": "Create compliance request(s)", "tags": [ "Compliance Requests" ], "description": "Create new compliance request(s) in a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "captureUrl": { "type": "string" }, "concordId": { "type": "string", "format": "uuid" }, "domain": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 2048 }, "preverified": { "type": "boolean", "default": false }, "projectUserId": { "type": "string" }, "request": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] }, "requestDetails": { "anyOf": [ { "type": "string" }, { "type": "string" } ] }, "userEmail": { "type": "string", "format": "email" }, "userFirstName": { "type": "string" }, "userId": { "type": "string" }, "userLastName": { "type": "string" }, "userPhoneNumber": { "type": "string" } }, "required": [ "request" ], "additionalProperties": false, "anyOf": [ { "required": [ "concordId" ] }, { "required": [ "userEmail" ] }, { "required": [ "userPhoneNumber" ] }, { "required": [ "projectUserId" ] }, { "required": [ "userId" ] } ] } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "downloadDate": { "type": "integer" }, "filePurgeDate": { "type": "integer" }, "files": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "apiKey": { "type": "string" }, "date": { "type": "integer" }, "dateCreated": { "type": "integer" }, "details": { "type": "string" }, "event": { "type": "string" }, "fileName": { "type": "string", "maxLength": 255 }, "filePath": { "type": "string" }, "fileSize": { "type": "number", "maximum": 10485760 }, "bucket": { "type": "string" }, "key": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "fileName" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid" }, "acknowledgedDate": { "type": "integer" }, "captureUrl": { "type": "string" }, "concordId": { "type": "string", "format": "uuid" }, "dataSystemTasks": { "type": "array", "items": { "type": "object", "properties": { "dataSystem": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "icon": { "type": "string" }, "dataSystemTypeId": { "type": "string" } }, "additionalProperties": false } ] }, "trustCenter": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "completed": { "type": "boolean" }, "completedAt": { "type": "integer" }, "completedBy": { "type": "string" }, "completionRecord": { "type": "object", "properties": {}, "additionalProperties": true } }, "required": [ "completed" ], "additionalProperties": false } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "domain": { "type": "string" }, "notes": { "type": "string", "maxLength": 2048 }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "preverified": { "type": "boolean" }, "resolution": { "type": "string", "maxLength": 2048 }, "resolutionStatus": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ], "maxLength": 2048 }, "resolvedDate": { "type": "string", "format": "date-time" }, "request": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] }, "requestDate": { "type": "integer" }, "requestDetails": { "type": "string" }, "session": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "anyOf": [ { "enum": [ "localhost" ] }, { "type": "string" } ] }, "geography": { "type": "string" }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] }, "user": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false }, "verifiedDate": { "type": "integer" }, "verificationMethod": { "type": "string", "enum": [ "email", "sms" ] }, "verificationRequestId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "concordId", "requestDate" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/compliance-requests/{complianceRequestId}": { "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests_compliancerequestid", "summary": "Update compliance request", "tags": [ "Compliance Requests" ], "description": "Updates a compliance request.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "status": { "type": "string", "enum": [ "acknowledged", "resolved" ] }, "notes": { "oneOf": [ { "type": "string" } ] }, "resolution": { "oneOf": [ { "type": "string", "maxLength": 2048 }, { "type": "string", "maxLength": 2048 } ] }, "resolutionStatus": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ], "maxLength": 2048 }, "dataSystemTasks": { "type": "array", "items": { "anyOf": [ { "type": "object", "properties": { "dataSystem": { "type": "string", "format": "uuid" }, "completed": { "type": "boolean" } }, "required": [ "dataSystem", "completed" ], "additionalProperties": false }, { "type": "object", "properties": { "trustCenter": { "type": "string", "format": "uuid" }, "completed": { "type": "boolean" } }, "required": [ "trustCenter", "completed" ], "additionalProperties": false } ] } } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "complianceRequestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "downloadDate": { "type": "integer" }, "filePurgeDate": { "type": "integer" }, "files": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string" }, "apiKey": { "type": "string" }, "date": { "type": "integer" }, "dateCreated": { "type": "integer" }, "details": { "type": "string" }, "event": { "type": "string" }, "fileName": { "type": "string", "maxLength": 255 }, "filePath": { "type": "string" }, "fileSize": { "type": "number", "maximum": 10485760 }, "bucket": { "type": "string" }, "key": { "type": "string" }, "contentType": { "type": "string" } }, "required": [ "fileName" ], "additionalProperties": false } }, "id": { "type": "string", "format": "uuid" }, "acknowledgedDate": { "type": "integer" }, "captureUrl": { "type": "string" }, "concordId": { "type": "string", "format": "uuid" }, "dataSystemTasks": { "type": "array", "items": { "type": "object", "properties": { "dataSystem": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "icon": { "type": "string" }, "dataSystemTypeId": { "type": "string" } }, "additionalProperties": false } ] }, "trustCenter": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "completed": { "type": "boolean" }, "completedAt": { "type": "integer" }, "completedBy": { "type": "string" }, "completionRecord": { "type": "object", "properties": {}, "additionalProperties": true } }, "required": [ "completed" ], "additionalProperties": false } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "domain": { "type": "string" }, "notes": { "type": "string", "maxLength": 2048 }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "preverified": { "type": "boolean" }, "resolution": { "type": "string", "maxLength": 2048 }, "resolutionStatus": { "type": "string", "enum": [ "completed", "no_records_found", "partially_completed", "denied", "withdrawn" ], "maxLength": 2048 }, "resolvedDate": { "type": "string", "format": "date-time" }, "request": { "type": "string", "enum": [ "change", "delete", "view", "do_not_sell" ] }, "requestDate": { "type": "integer" }, "requestDetails": { "type": "string" }, "session": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "anyOf": [ { "enum": [ "localhost" ] }, { "type": "string" } ] }, "geography": { "type": "string" }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "status": { "type": "string", "enum": [ "pending_verification", "submitted", "acknowledged", "resolved" ] }, "user": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false }, "verifiedDate": { "type": "integer" }, "verificationMethod": { "type": "string", "enum": [ "email", "sms" ] }, "verificationRequestId": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } }, "required": [ "id", "concordId", "requestDate" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/compliance-requests-events": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests_events", "summary": "Get project level compliance requests events", "tags": [ "Compliance Requests" ], "description": "Gets the compliance request events for a project.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "accountId", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "complianceRequestId", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "query", "name": "complianceRequestEventId", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "endDate", "required": false }, { "schema": { "type": "integer", "default": 100, "minimum": 1, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "startDate", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "accountId": { "type": "string", "format": "uuid" }, "complianceRequestId": { "type": "string", "format": "uuid" }, "details": { "type": "object", "properties": { "downloadedFilesCount": { "type": "number" }, "uploadedFilesCount": { "type": "number" }, "requestDownloadId": { "type": "string", "format": "uuid" }, "fileName": { "type": "string", "maxLength": 255 } }, "additionalProperties": false }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "event": { "type": "string" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" } }, "required": [ "complianceRequestId", "event", "organizationId", "projectId" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/compliance-requests/{complianceRequestId}/file": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests_compliancerequestid_file", "summary": "Upload a compliance request file", "tags": [ "Compliance Requests" ], "description": "Uploads a compliance request file to a request.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "complianceRequestId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/compliance-requests/{complianceRequestId}/trust-center-exports": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_projects_projectid_compliance_requests_compliancerequestid_trust_center_exports", "summary": "Generate + attach a trust-center subscriber export for a VIEW DSAR task", "tags": [ "Compliance Requests" ], "description": "Runs `exportSubscriberData` for the synthetic trust-center task and uploads the resulting JSON to the request's file store. The existing PATCH-on-resolve flow picks it up in the download zip automatically. Idempotent on re-click (overwrites the prior export under the same filename). Does NOT mark the task completed — admin handles that separately when they resolve the request.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "trustCenterId": { "type": "string", "format": "uuid" } }, "required": [ "trustCenterId" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "complianceRequestId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "fileName": { "type": "string" }, "fileSize": { "type": "number" } }, "required": [ "fileName", "fileSize" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/consent-events": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_consent_events", "summary": "Get the consent events for a project.", "tags": [ "Consent Events" ], "description": "Get project level consent events", "parameters": [ { "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": "startDate", "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": "endDate", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string", "maxLength": 128 } ] }, "in": "query", "name": "category", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string", "maxLength": 128 } ] }, "in": "query", "name": "subcategory", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "label", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "consentState", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "submitter", "required": false }, { "schema": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "sessionId", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "geography", "required": false }, { "schema": { "type": "array", "items": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "implied", "user_click" ] } }, { "type": "string", "maxLength": 36 } ] } }, "in": "query", "name": "consentAction", "required": false }, { "schema": { "type": "string", "minLength": 1, "maxLength": 64 }, "in": "query", "name": "concordId", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string", "minLength": 1 }, "in": "query", "name": "order", "required": false }, { "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}-[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": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "count": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "total": { "type": "integer", "minimum": -9007199254740991, "maximum": 9007199254740991 }, "items": { "type": "array", "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_privacy_v1_organizations_organizationid_projects_projectid_consent_events", "summary": "Create consent event(s)", "tags": [ "Consent Events" ], "description": "Create new consent event(s) in a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "items": { "type": "array", "minItems": 1, "items": { "type": "object", "properties": { "projectUserId": { "type": "string" }, "userId": { "type": "string" }, "email": { "type": "string", "format": "email" }, "phoneNumber": { "type": "string" }, "concordId": { "type": "string", "format": "uuid" }, "consentType": { "type": "string", "format": "uuid" }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "pattern": "^[a-z0-9_]{1,36}$" }, "consentState": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] }, "consentAction": { "type": "string", "enum": [ "implied", "user_click" ] }, "consentDate": { "type": "string", "format": "date-time" }, "expirationDate": { "type": "string", "format": "date-time" } }, "required": [ "consentState", "consentAction" ], "additionalProperties": false, "allOf": [ { "anyOf": [ { "required": [ "concordId" ] }, { "required": [ "email" ] }, { "required": [ "phoneNumber" ] }, { "required": [ "projectUserId" ] }, { "required": [ "userId" ] } ] } ] } } }, "required": [ "items" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "count": { "type": "number" }, "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "concordId": { "type": "string", "format": "uuid" }, "consentAction": { "type": "string", "enum": [ "implied", "user_click" ] }, "consentDate": { "type": "string", "format": "date-time" }, "consentState": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "consentType": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ] }, "expirationDate": { "type": "string", "format": "date-time" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "session": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "domain": { "anyOf": [ { "enum": [ "localhost" ] }, { "type": "string" } ] }, "geography": { "type": "string" }, "userAgent": { "type": "string" } }, "additionalProperties": false }, "submitter": { "type": "string", "format": "uuid" }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" } }, "required": [ "id", "concordId", "consentAction", "consentDate", "consentState", "expirationDate" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/consent-types/{consentTypeId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid_consent_types_consenttypeid", "summary": "Delete consent type", "tags": [ "Consent Types" ], "description": "Delete a consent type for a project.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "consentTypeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "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_privacy_v1_organizations_organizationid_projects_projectid_consent_types_consenttypeid", "summary": "Update consent type", "tags": [ "Consent Types" ], "description": "Update a consent type for a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 5, "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "consentDuration": { "type": "string", "format": "duration" }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "required": { "type": "boolean" }, "requireReaccept": { "type": "boolean" } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "consentTypeId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/consent-types": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_consent_types", "summary": "Get consent types", "tags": [ "Consent Types" ], "description": "Get consent types for a project.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] } }, { "type": "string", "maxLength": 128 } ] }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "array", "items": { "anyOf": [ { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" }, { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement", "email", "phone", "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 } ] } }, "in": "query", "name": "subcategory", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" } }, { "type": "string", "maxLength": 128 } ] }, "in": "query", "name": "label", "required": false }, { "schema": { "type": "string", "maxLength": 100 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "format": "uri" }, "in": "query", "name": "url", "required": false }, { "schema": { "type": "number" }, "in": "query", "name": "version", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "all", "current", "active", "archived", "obsolete", "test" ] } }, { "type": "string", "enum": [ "all", "current", "active", "archived", "obsolete", "test" ] } ] }, "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": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_projects_projectid_consent_types", "summary": "Create consent type", "tags": [ "Consent Types" ], "description": "Create a new consent type in a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "name": { "type": "string", "minLength": 5, "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "consentDuration": { "type": "string", "format": "duration" }, "status": { "type": "string", "default": "active", "enum": [ "active", "test", "archived" ] }, "required": { "type": "boolean", "default": false }, "requireReaccept": { "type": "boolean", "default": false } }, "required": [ "category", "subcategory", "label" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/domains/{domainId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid_domains_domainid", "summary": "Delete a domain", "tags": [ "Domains" ], "description": "Deletes a domain from a project.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "domainId", "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" }, "domain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "source": { "type": "string", "default": "privacy", "enum": [ "privacy", "trust" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "projectId", "domain", "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_privacy_v1_organizations_organizationid_projects_projectid_domains_domainid", "summary": "Update domain", "tags": [ "Domains" ], "description": "Updates a domain in a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 1024 }, "domain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "domainId", "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" }, "domain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "source": { "type": "string", "default": "privacy", "enum": [ "privacy", "trust" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "projectId", "domain", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/domains": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_domains", "summary": "Get domains", "tags": [ "Domains" ], "description": "Get the domains for a project.", "parameters": [ { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "domain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "source": { "type": "string", "default": "privacy", "enum": [ "privacy", "trust" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "projectId", "domain", "dateCreated", "dateUpdated" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_projects_projectid_domains", "summary": "Create a new domain", "tags": [ "Domains" ], "description": "Creates a domain in a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "domain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] } }, "required": [ "domain" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "name": { "type": "string" }, "domain": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] }, "source": { "type": "string", "default": "privacy", "enum": [ "privacy", "trust" ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" } }, "required": [ "id", "organizationId", "projectId", "domain", "dateCreated", "dateUpdated" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/gcm-scan-results": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_gcm_scan_results", "summary": "Get GCM scan results", "tags": [ "GCM Scans" ], "description": "Gets the GCM scan results for a project.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "projectId": { "oneOf": [ { "type": "string" } ] }, "gcmScanHistoryId": { "oneOf": [ { "type": "string" } ] }, "url": { "type": "string", "format": "uri" }, "domain": { "type": "string" }, "dateDetected": { "type": "integer" }, "status": { "type": "string", "enum": [ "success", "warning", "error" ] }, "statusMsg": { "type": "string" } }, "required": [ "dateCreated", "dateUpdated", "url", "domain", "dateDetected", "status", "statusMsg" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/gcm-scans": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_projects_projectid_gcm_scans", "summary": "Create gcm scan", "tags": [ "GCM Scans" ], "description": "Start a new manual gcm scan for the current project or a custom domain (billed per domain scanned; the weekly auto-run is free).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 2048 }, "createTaskOnFailure": { "type": "boolean" } }, "additionalProperties": false } } } }, "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": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "taskStarted": { "type": "boolean" }, "organizationId": { "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)$" }, "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)$" }, "domainsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "taskStarted", "organizationId", "projectId", "domainsCount" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/compliance-scans": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_projects_projectid_compliance_scans", "summary": "Create compliance scan", "tags": [ "Compliance Scans" ], "description": "Start a managed compliance scan for an authorized target (a registered project domain or a subdomain whose registrable parent matches one).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "target": { "type": "string", "minLength": 1, "maxLength": 2048 }, "jurisdictionCode": { "type": "string" }, "jurisdictions": { "minItems": 1, "type": "array", "items": { "type": "string" } }, "enabledCheckGroups": { "minItems": 1, "type": "array", "items": { "type": "string", "enum": [ "pre-consent", "gpc", "choice-symmetry", "reject-efficacy", "policy-freshness", "dsar", "consent-state", "do-not-sell", "cipa-tracking" ] } } }, "required": [ "target" ], "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": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "taskStarted": { "type": "boolean" }, "organizationId": { "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)$" }, "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)$" }, "target": { "type": "string" }, "parentDomain": { "type": "string" }, "runs": { "type": "array", "items": { "type": "object", "properties": { "jurisdictionCode": { "type": "string" }, "runId": { "type": "string" }, "taskStarted": { "type": "boolean" }, "gatePassed": { "type": "boolean" } }, "required": [ "runId", "taskStarted", "gatePassed" ], "additionalProperties": false } } }, "required": [ "taskStarted", "organizationId", "projectId", "target", "parentDomain", "runs" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid", "summary": "Delete project", "tags": [ "Projects" ], "description": "Deletes a project.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "status" ], "additionalProperties": false } } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "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_privacy_v1_organizations_organizationid_projects_projectid", "summary": "Get project", "tags": [ "Projects" ], "description": "Gets a project.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "status" ], "additionalProperties": false } } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "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_privacy_v1_organizations_organizationid_projects_projectid", "summary": "Update project", "tags": [ "Projects" ], "description": "Updates a project.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "sendFromEmailId": { "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "settings": { "type": "object", "properties": { "trackers": { "type": "object", "properties": { "deepScan": { "type": "boolean" }, "realTimeScan": { "type": "boolean" }, "autoAddTrackers": { "type": "boolean" }, "autoAddRealTimeTrackers": { "type": "boolean" } }, "additionalProperties": false } }, "additionalProperties": false }, "dataSystemIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "status" ], "additionalProperties": false } } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/branding": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_branding", "summary": "Get project branding", "tags": [ "Projects" ], "description": "Returns the project-level branding. Privacy experiences inherit it (region -> project -> org -> default).", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "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_privacy_v1_organizations_organizationid_projects_projectid_branding", "summary": "Update project branding", "tags": [ "Projects" ], "description": "Updates the project-level branding that privacy experiences inherit. Sending null for a field clears it so it inherits org branding.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "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}/projects": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects", "summary": "Get projects", "tags": [ "Projects" ], "description": "Gets projects for an organization.", "parameters": [ { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "sendFromEmail", "required": false }, { "schema": { "type": "string", "maxLength": 64 }, "in": "query", "name": "contactEmails", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "enum": [ "all", "active", "test", "archived" ] } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "status", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] }, "dataSystems": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "globalDataSystemId": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "dataLocations": { "type": "array", "default": [], "items": { "type": "string" } }, "crossBorder": { "type": "boolean", "default": false }, "retention": { "type": "string", "default": "P2Y", "format": "duration" }, "additionalNotes": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "status": { "type": "string", "enum": [ "active", "archived", "test" ] }, "dataSystemContacts": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDestinations": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemRelationship": { "oneOf": [ { "type": "object" } ] }, "dataSystemSecurityMeasures": { "oneOf": [ { "type": "array", "items": {} } ] }, "dataSystemOrigins": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "processingActivities": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemProcessingPurposes": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataCategories": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "pIIType": { "oneOf": [ { "type": "string" } ] } }, "required": [ "id", "name" ], "additionalProperties": false } }, "dataSystemDataSubjects": { "type": "array", "default": [], "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 } }, "required": [ "id", "name" ], "additionalProperties": false } }, "icon": { "type": "string" }, "catalogSlug": { "oneOf": [ { "type": "string" } ] }, "projectIds": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "id", "dateCreated", "dateUpdated", "organizationId", "organizationName", "name", "status" ], "additionalProperties": false } } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_projects", "summary": "Create new project", "tags": [ "Projects" ], "description": "Create a new project in an organization", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "type": { "enum": [ "website" ] }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "additionalRegions": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false } }, "required": [ "name", "regions", "settings" ], "additionalProperties": false } }, "regionTemplate": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "oneOf": [ { "type": "string" } ] }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "hideUnusedCategories": { "type": "boolean" }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number" }, "gcm": { "type": "string", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string" }, "impliedConsentDelay": { "type": "number", "minimum": 0, "maximum": 30 }, "microsoftUET": { "type": "string", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean" }, "wordpress": { "type": "boolean" }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "dataCategories": { "type": "array", "items": { "type": "number" } } }, "required": [ "vendorId", "framework" ], "additionalProperties": false } }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" } }, "additionalProperties": false }, "consentMode": { "oneOf": [ { "enum": [ "express" ] }, { "type": "string", "enum": [ "implied", "express" ] } ] }, "privacyMode": { "oneOf": [ { "enum": [ "categories_only" ] }, { "oneOf": [ { "type": "string", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "layout": { "type": "string", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "oneOf": [ { "type": "string" } ] }, "title": { "type": "boolean" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean" }, "closeButton": { "type": "boolean" }, "closeButtonConsentBehavior": { "type": "string", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] }, "customizeButton": { "type": "boolean" }, "doNotSellSwitch": { "type": "boolean" }, "policySelections": { "type": "object", "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean" }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] }, "limitPii": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] } }, "additionalProperties": false }, "crossSiteTracking": { "type": "boolean" }, "crossDeviceConsent": { "type": "boolean" }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "circleOffsetX": { "type": "string" }, "circleOffsetY": { "type": "string" }, "tabOffsetY": { "type": "string" }, "position": { "type": "string" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean" }, "consentHistoryMode": { "type": "string", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean" }, "dsrFormMode": { "type": "string", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean" }, "doNotSellRequests": { "type": "boolean" }, "position": { "type": "string" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean" }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "defaultLanguage": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false }, "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "domains": { "type": "array", "uniqueItems": true, "items": { "anyOf": [ { "type": "string", "enum": [ "localhost", "127.0.0.1", "::1" ] }, { "type": "string" } ] } }, "privacyPolicyUrl": { "type": "string" }, "termsOfServiceUrl": { "type": "string" } }, "required": [ "name" ], "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": { "default": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "contactEmail": { "type": "string", "format": "email" }, "contactEmails": { "type": "array", "items": { "type": "string", "format": "email" } }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "id": { "type": "string", "format": "uuid" }, "mode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "organizationId": { "type": "string", "format": "uuid" }, "organization": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "minLength": 2, "maxLength": 1024 }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string" } }, "required": [ "id", "name", "slug" ], "additionalProperties": false }, "sendFromEmailId": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "sendFromEmail": { "type": "object", "properties": { "id": { "default": "default", "anyOf": [ { "enum": [ "default" ] }, { "type": "string", "format": "uuid" } ] }, "email": { "type": "string", "format": "email" }, "name": { "type": "string" } }, "additionalProperties": false }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "trackers": { "type": "object", "properties": { "autoAddTrackers": { "type": "boolean", "default": true }, "autoAddRealTimeTrackers": { "type": "boolean", "default": false }, "deepScan": { "type": "boolean", "default": true }, "realTimeScan": { "type": "boolean", "default": false }, "lastRealTimeScan": { "oneOf": [ { "type": "integer" } ] } }, "additionalProperties": false } }, "required": [ "trackers" ], "additionalProperties": false }, "slug": { "type": "string", "maxLength": 256 }, "status": { "type": "string", "enum": [ "active", "test", "archived" ] }, "statusFlags": { "type": "object", "properties": { "isActive": { "type": "boolean" }, "isTest": { "type": "boolean" } }, "additionalProperties": false }, "type": { "enum": [ "website" ] } }, "required": [ "dateCreated", "dateUpdated", "id", "name", "organizationId", "settings", "slug", "statusFlags", "type" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/tcf-vendors": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_tcf_vendors", "summary": "Get TCF vendors for admin management", "tags": [ "TCF Vendor Management" ], "description": "Retrieve TCF vendors for admin management interface with filtering options.", "parameters": [ { "schema": { "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0 } }, "in": "query", "name": "vendorIds", "required": false }, { "schema": { "type": "string", "enum": [ "IAB", "Google" ] }, "in": "query", "name": "framework", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0 } }, "in": "query", "name": "purposes", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 10000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "integer", "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "vendors": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string" }, "purposes": { "type": "array", "default": [], "items": { "type": "integer" } }, "legIntPurposes": { "type": "array", "default": [], "items": { "type": "integer" } }, "flexiblePurposes": { "type": "array", "default": [], "items": { "type": "integer" } }, "specialPurposes": { "type": "array", "default": [], "items": { "type": "integer" } }, "features": { "type": "array", "default": [], "items": { "type": "integer" } }, "specialFeatures": { "type": "array", "default": [], "items": { "type": "integer" } }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "usesNonCookieAccess": { "type": "boolean", "default": false }, "deviceStorageDisclosureUrl": { "type": "string" }, "urls": { "type": "array", "default": [], "items": { "type": "object", "properties": { "langId": { "type": "string" }, "privacy": { "type": "string" }, "legIntClaim": { "type": "string" } }, "additionalProperties": false } }, "domains": { "type": "array", "default": [], "items": { "type": "string" } }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer" } }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "integer" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "cookieRefresh": { "type": "boolean", "default": false }, "type": { "type": "string", "enum": [ "iab_tcf", "google_atp" ] }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "vendorId": { "oneOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "integer", "exclusiveMinimum": 0 } ] }, "providerId": { "oneOf": [ { "type": "integer", "exclusiveMinimum": 0 }, { "type": "integer", "exclusiveMinimum": 0 } ] }, "policyUrl": { "oneOf": [ { "type": "string" }, { "type": "string" } ] }, "deletedDate": { "oneOf": [ { "type": "integer" } ] }, "lastUpdated": { "type": "integer" } }, "required": [ "name", "type", "framework" ], "additionalProperties": false } }, "lastUpdated": { "type": "integer" }, "gvlSpecificationVersion": { "oneOf": [ { "type": "integer" }, { "type": "integer" } ] }, "atpSpecificationVersion": { "oneOf": [ { "type": "integer" }, { "type": "integer" } ] }, "vendorListVersion": { "oneOf": [ { "type": "integer" }, { "type": "integer" } ] }, "tcfPolicyVersion": { "oneOf": [ { "type": "integer" }, { "type": "integer" } ] }, "count": { "type": "integer", "minimum": 0 } }, "required": [ "vendors", "lastUpdated", "count" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}/tcf-vendor-selections": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_tcf_vendor_selections", "summary": "Get TCF vendor selections", "tags": [ "TCF Vendor Management" ], "description": "Retrieve the vendor selections for a region.", "parameters": [ { "schema": { "type": "string", "enum": [ "IAB", "Google" ] }, "in": "query", "name": "framework", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "selections": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "integer", "exclusiveMinimum": 0 }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "updatedAt": { "type": "integer" } }, "required": [ "vendorId", "framework" ], "additionalProperties": false } }, "count": { "type": "integer", "minimum": 0 } }, "required": [ "selections", "count" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}/tcf-vendor-selection": { "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_tcf_vendor_selection", "summary": "Update TCF vendor selections", "tags": [ "TCF Vendor Management" ], "description": "Update TCF vendor selections for a region. Supports both single vendor and bulk updates.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selectedVendors": { "type": "array", "items": { "type": "integer", "exclusiveMinimum": 0 } }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] } }, "required": [ "selectedVendors", "framework" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "integer", "exclusiveMinimum": 0 }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "name": { "type": "string" }, "policyUrl": { "type": "string" } }, "required": [ "vendorId", "framework", "addedAt" ], "additionalProperties": true } } }, "required": [ "framework", "selectedVendors" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/tcf-stacks": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_tcf_stacks", "summary": "Get TCF stacks for admin management", "tags": [ "TCF Stack Management" ], "description": "Retrieve TCF stacks for admin management interface with filtering options.", "parameters": [ { "schema": { "type": "string" }, "in": "query", "name": "stackIds", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "integer", "minimum": 1 }, "in": "query", "name": "page", "required": false }, { "schema": { "type": "integer", "minimum": 1, "maximum": 100 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "stacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "purposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } } }, "required": [ "stackId", "name", "description", "purposes", "specialFeatures" ], "additionalProperties": false } }, "pagination": { "type": "object", "properties": { "page": { "type": "integer", "minimum": 1 }, "limit": { "type": "integer", "minimum": 1 }, "total": { "type": "integer", "minimum": 0 } }, "required": [ "page", "limit", "total" ], "additionalProperties": false } }, "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}/tcf-stack-selections": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_tcf_stack_selections", "summary": "Get TCF stack selections for region", "tags": [ "TCF Stack Management" ], "description": "Retrieve TCF stack selections for a specific region template.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "regionId": { "type": "string" }, "selectedStacks": { "type": "array", "items": { "type": "number" } }, "metadata": { "type": "object", "properties": { "lastUpdated": { "type": "string", "format": "date-time" }, "version": { "type": "number" } }, "required": [ "lastUpdated", "version" ], "additionalProperties": false } }, "required": [ "regionId", "selectedStacks" ], "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_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_tcf_stack_selections", "summary": "Update TCF stack selections for region", "tags": [ "TCF Stack Management" ], "description": "Update TCF stack selections for a specific region template.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "legalBasis": { "default": "consent", "enum": [ "consent" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "required": [ "selectedStacks" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "regionId": { "type": "string" }, "selectedStacks": { "type": "array", "items": { "type": "number" } }, "metadata": { "type": "object", "properties": { "lastUpdated": { "type": "string", "format": "date-time" }, "version": { "type": "number" } }, "required": [ "lastUpdated", "version" ], "additionalProperties": false } }, "required": [ "regionId", "selectedStacks" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/tcf-purposes": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_tcf_purposes", "summary": "Get TCF purposes from GVL", "tags": [ "TCF Purpose Management" ], "description": "Retrieve IAB TCF purposes, special purposes, features, or special features from the Global Vendor List.", "parameters": [ { "schema": { "type": "string", "default": "purpose", "enum": [ "purpose", "specialPurpose", "feature", "specialFeature", "stack", "dataCategory" ] }, "in": "query", "name": "type", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "ids", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "search", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "gvlSpecificationVersion": { "type": "number" }, "vendorListVersion": { "type": "number" }, "tcfPolicyVersion": { "type": "number" }, "type": { "type": "string" }, "purposes": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "number" }, "name": { "type": "string" }, "description": { "type": "string" }, "descriptionLegal": { "type": "string" }, "illustrations": { "type": "array", "items": { "type": "string" } }, "purposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } } }, "required": [ "id", "name", "description" ], "additionalProperties": false } }, "count": { "type": "number" } }, "required": [ "gvlSpecificationVersion", "vendorListVersion", "tcfPolicyVersion", "type", "count" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid", "summary": "Delete region", "tags": [ "Regions" ], "description": "Deletes an existing region.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "slug": { "type": "string", "maxLength": 256 } }, "required": [ "name", "regions", "settings", "id", "projectId", "dateCreated", "dateUpdated", "slug" ], "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_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid", "summary": "Get region", "tags": [ "Regions" ], "description": "Gets a region.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "slug": { "type": "string", "maxLength": 256 } }, "required": [ "name", "regions", "settings", "id", "projectId", "dateCreated", "dateUpdated", "slug" ], "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_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid", "summary": "Update region", "tags": [ "Regions" ], "description": "Updates an existing region.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "oneOf": [ { "type": "string" } ] }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "hideUnusedCategories": { "type": "boolean" }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number" }, "gcm": { "type": "string", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string" }, "impliedConsentDelay": { "type": "number", "minimum": 0, "maximum": 30 }, "microsoftUET": { "type": "string", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean" }, "wordpress": { "type": "boolean" }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } }, "dataCategories": { "type": "array", "items": { "type": "number" } } }, "required": [ "vendorId", "framework" ], "additionalProperties": false } }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" } }, "additionalProperties": false }, "consentMode": { "oneOf": [ { "enum": [ "express" ] }, { "type": "string", "enum": [ "implied", "express" ] } ] }, "privacyMode": { "oneOf": [ { "enum": [ "categories_only" ] }, { "oneOf": [ { "type": "string", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "layout": { "type": "string", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "oneOf": [ { "type": "string" } ] }, "title": { "type": "boolean" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean" }, "closeButton": { "type": "boolean" }, "closeButtonConsentBehavior": { "type": "string", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] }, "customizeButton": { "type": "boolean" }, "doNotSellSwitch": { "type": "boolean" }, "policySelections": { "type": "object", "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean" }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "gpc": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] }, "limitPii": { "oneOf": [ { "enum": [ false ] }, { "type": "boolean" } ] } }, "additionalProperties": false }, "crossSiteTracking": { "type": "boolean" }, "crossDeviceConsent": { "type": "boolean" }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "circleOffsetX": { "type": "string" }, "circleOffsetY": { "type": "string" }, "tabOffsetY": { "type": "string" }, "position": { "type": "string" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark" ] } }, "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean" }, "consentHistoryMode": { "type": "string", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean" }, "dsrFormMode": { "type": "string", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean" }, "doNotSellRequests": { "type": "boolean" }, "position": { "type": "string" }, "theme": { "type": "string", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean" }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "additionalProperties": false } }, "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "defaultLanguage": { "type": "string" } }, "additionalProperties": false } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "boolean" }, "in": "query", "name": "skipCacheInvalidation", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "slug": { "type": "string", "maxLength": 256 } }, "required": [ "name", "regions", "settings", "id", "projectId", "dateCreated", "dateUpdated", "slug" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/regions/{regionId}/branding/resolved": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_regions_regionid_branding_resolved", "summary": "Get resolved branding", "tags": [ "Regions" ], "description": "Gets the effective branding for a region (region -> project -> org -> default), matching what the widget renders.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "regionId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "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}/projects/{projectId}/regions": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_regions", "summary": "Get regions", "tags": [ "Regions" ], "description": "Gets regions for a project.", "parameters": [ { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "maxLength": 2 }, "in": "query", "name": "regionCountry", "required": false }, { "schema": { "type": "string", "maxLength": 6 }, "in": "query", "name": "regionSubDivision", "required": false }, { "schema": { "type": "string", "maxLength": 16 }, "in": "query", "name": "consentMode", "required": false }, { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "maxLength": 16 } }, { "type": "string", "maxLength": 16 } ] }, "in": "query", "name": "blockingMode", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "enableDoNotSell", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "enableGpc", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "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", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "slug": { "type": "string", "maxLength": 256 } }, "required": [ "name", "regions", "settings", "id", "projectId", "dateCreated", "dateUpdated", "slug" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_projects_projectid_regions", "summary": "Create region", "tags": [ "Regions" ], "description": "Creates a new region.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false } }, "required": [ "name", "regions", "settings" ], "additionalProperties": false } } }, "required": true }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "regions": { "anyOf": [ { "enum": [ "default" ] }, { "type": "array", "items": { "type": "object", "properties": { "country": { "type": "string", "maxLength": 2 }, "subDivision": { "type": "string", "maxLength": 6 } }, "additionalProperties": false } } ] }, "customScript": { "type": "string", "maxLength": 10240 }, "settings": { "type": "object", "properties": { "branding": { "type": "object", "properties": { "buttonRadius": { "oneOf": [ { "type": "string" } ] }, "cardRadius": { "oneOf": [ { "type": "string" } ] }, "font": { "oneOf": [ { "type": "string" } ] }, "logoUrl": { "oneOf": [ { "type": "string" } ] }, "iconUrl": { "oneOf": [ { "type": "string" } ] }, "primaryColor": { "oneOf": [ { "type": "string" } ] }, "secondaryColor": { "oneOf": [ { "type": "string" } ] }, "poweredByConcord": { "oneOf": [ { "type": "boolean" } ] } }, "additionalProperties": false }, "consent": { "type": "object", "properties": { "blockingMode": { "type": "string", "enum": [ "disabled", "discovery", "permissive", "strict" ] }, "consentMode": { "type": "string", "enum": [ "implied", "express" ] }, "privacyMode": { "oneOf": [ { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] }, { "type": "string", "default": "categories_dns", "enum": [ "dns_only", "categories_only", "categories_dns" ] } ] }, "consentBanner": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "layout": { "type": "string", "default": "bar", "enum": [ "bar", "box" ] }, "position": { "oneOf": [ { "type": "string", "default": "bottom", "enum": [ "top", "bottom", "center", "left_bottom", "left_top", "right_bottom", "right_top" ] }, { "type": "string", "default": "center", "enum": [ "center", "left_bottom", "left_top", "right_bottom", "right_top", "top", "bottom" ] } ] }, "policy": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "createdAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "updatedAt": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "organization": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "project": { "anyOf": [ { "type": "string", "format": "uuid" }, { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "name": { "type": "string" } }, "additionalProperties": false } ] }, "category": { "anyOf": [ { "type": "string", "enum": [ "disclosure", "communication", "privacy_setting", "custom" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "subcategory": { "anyOf": [ { "anyOf": [ { "type": "string", "enum": [ "privacy_policy", "terms_of_service", "cookie_policy", "data_protection_agreement" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "email", "phone" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified" ], "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "anyOf": [ { "type": "string", "maxLength": 128 }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_*]{1,121}$" } ] }, { "type": "string", "maxLength": 128, "pattern": "^custom_[a-z0-9_]{1,121}$" } ] }, "label": { "type": "string", "maxLength": 128, "pattern": "[a-z0-9_*]{1,128}$" }, "version": { "type": "integer" }, "dateCreated": { "type": "string", "format": "date-time" }, "dateUpdated": { "type": "string", "format": "date-time" }, "name": { "type": "string", "maxLength": 100 }, "description": { "type": "string", "maxLength": 2000 }, "document": { "type": "string", "maxLength": 5000000 }, "url": { "type": "string", "format": "uri" }, "readOnly": { "type": "boolean", "default": false }, "validStates": { "type": "array", "items": { "type": "string", "enum": [ "implied", "viewed", "accepted", "declined" ] } }, "status": { "type": "string", "enum": [ "active", "archived", "obsolete", "test" ] }, "consentDuration": { "type": "string" }, "required": { "type": "boolean", "default": false }, "requireReacceptVersion": { "type": "integer" } }, "required": [ "id", "project", "version", "name", "description" ], "additionalProperties": false } ], "type": "null" }, "title": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "acceptButton": { "type": "boolean", "default": true }, "closeButton": { "type": "boolean", "default": true }, "closeButtonConsentBehavior": { "type": "string", "default": "default", "enum": [ "default", "deny_all" ] }, "denyButton": { "oneOf": [ { "default": false, "enum": [ false ] }, { "type": "boolean", "default": true } ] }, "customizeButton": { "type": "boolean", "default": true }, "doNotSellSwitch": { "type": "boolean", "default": true }, "policySelections": { "type": "object", "default": {}, "properties": { "privacy_policy": { "type": "string", "format": "uuid" }, "terms_of_service": { "type": "string", "format": "uuid" }, "cookie_policy": { "type": "string", "format": "uuid" }, "data_protection_agreement": { "type": "string", "format": "uuid" } }, "additionalProperties": false }, "showGooglePrivacyPolicy": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "layout", "title", "theme", "closeButton", "customizeButton" ], "additionalProperties": false }, "hideUnusedCategories": { "type": "boolean", "default": false }, "doNotSell": { "type": "boolean" }, "consentDuration": { "type": "number", "default": 6, "minimum": 0 }, "gcm": { "type": "string", "default": "advanced", "enum": [ "disabled", "basic", "advanced" ] }, "gcmPolicy": { "type": "string", "default": "https://business.safety.google/privacy/" }, "gpc": { "type": "boolean", "default": false }, "impliedConsentDelay": { "type": "number", "default": 0, "minimum": 0, "maximum": 30 }, "limitPii": { "type": "boolean", "default": false }, "microsoftUET": { "type": "string", "default": "disabled", "enum": [ "disabled", "enabled", "enabled_with_clarity" ] }, "webflow": { "type": "boolean", "default": true }, "wordpress": { "type": "boolean", "default": true }, "tcfConfig": { "type": "object", "properties": { "enabled": { "type": "boolean" }, "mode": { "type": "string", "enum": [ "disabled", "iab_tcf_v2_3", "iab_tcf_v2_3_with_google" ] }, "selectedVendors": { "type": "array", "items": { "type": "object", "properties": { "vendorId": { "type": "number" }, "name": { "type": "string" }, "framework": { "type": "string", "enum": [ "IAB", "Google" ] }, "addedAt": { "type": "integer" }, "purposes": { "type": "array", "items": { "type": "number" } }, "flexiblePurposes": { "type": "array", "items": { "type": "number" } }, "specialPurposes": { "type": "array", "items": { "type": "number" } }, "specialFeatures": { "type": "array", "items": { "type": "number" } }, "features": { "type": "array", "items": { "type": "number" } }, "legIntPurposes": { "type": "array", "items": { "type": "number" } }, "policyUrl": { "type": "string", "format": "uri" }, "cookieMaxAgeSeconds": { "oneOf": [ { "type": "number" } ] }, "cookieRefresh": { "type": "boolean" }, "usesNonCookieAccess": { "type": "boolean" }, "deviceStorageDisclosureUrl": { "type": "string", "format": "uri" }, "dataRetention": { "type": "object", "properties": { "stdRetention": { "type": "number" }, "purposes": { "type": "object", "properties": {}, "additionalProperties": false }, "specialPurposes": { "type": "object", "properties": {}, "additionalProperties": false } }, "additionalProperties": false }, "dataDeclaration": { "type": "array", "default": [], "items": { "type": "integer", "exclusiveMinimum": 0 } }, "urls": { "type": "array", "items": { "type": "object", "properties": { "privacy": { "type": "string", "format": "uri" }, "legIntClaim": { "type": "string", "format": "uri" } }, "additionalProperties": false } } }, "required": [ "vendorId", "name", "framework" ], "additionalProperties": false } }, "publisherCC": { "oneOf": [ { "type": "string" } ] }, "specialPurposeOneTreatment": { "type": "boolean" }, "legitimateInterestEnabled": { "type": "boolean" }, "enableAdvertiserConsentMode": { "type": "boolean" }, "selectedStacks": { "type": "array", "items": { "type": "object", "properties": { "stackId": { "type": "number" }, "addedAt": { "type": "integer" }, "legalBasis": { "type": "string", "enum": [ "consent", "legitimate_interest" ] } }, "required": [ "stackId" ], "additionalProperties": false } } }, "additionalProperties": false } }, "required": [ "blockingMode", "consentMode", "consentDuration", "gcm", "gpc" ], "additionalProperties": false }, "crossSiteTracking": { "type": "boolean", "default": false }, "crossDeviceConsent": { "type": "boolean", "default": false }, "floatingButton": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "circleOffsetX": { "type": "string", "default": "24px" }, "circleOffsetY": { "type": "string", "default": "24px" }, "tabOffsetY": { "type": "string", "default": "256px" }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] }, "type": { "type": "string", "default": "circle", "enum": [ "circle", "tab" ] }, "icon": { "type": "string", "default": "cookie", "enum": [ "cookie", "fingerprint", "shield" ] }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "enabled", "circleOffsetX", "circleOffsetY", "tabOffsetY", "position", "theme", "type", "icon" ], "additionalProperties": false }, "placeholders": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": true }, "theme": { "type": "string", "default": "light", "enum": [ "brand", "light", "dark" ] } }, "required": [ "enabled", "theme" ], "additionalProperties": false }, "privacyCenter": { "type": "object", "properties": { "consentHistory": { "type": "boolean", "default": true }, "consentHistoryMode": { "type": "string", "default": "standard", "enum": [ "legacy", "standard", "both" ] }, "disclosures": { "type": "boolean", "default": true }, "dsrFormMode": { "type": "string", "default": "multi", "enum": [ "single", "multi" ] }, "excludedDisclosureIds": { "type": "array", "items": { "type": "string", "format": "uuid" } }, "privacyRequests": { "type": "boolean", "default": true }, "doNotSellRequests": { "type": "boolean", "default": true }, "position": { "type": "string", "default": "right" }, "theme": { "type": "string", "default": "classic", "enum": [ "brand", "light", "dark", "classic" ] }, "vendors": { "type": "boolean", "default": true }, "customCssVariables": { "oneOf": [ { "type": "string" } ] }, "customCss": { "oneOf": [ { "type": "string" } ] } }, "required": [ "disclosures", "privacyRequests", "doNotSellRequests", "position", "theme" ], "additionalProperties": false } }, "required": [ "consent" ], "additionalProperties": false }, "language": { "type": "object", "properties": { "enabled": { "type": "boolean", "default": false }, "defaultLanguage": { "type": "string", "default": "en_US" } }, "required": [ "enabled" ], "additionalProperties": false }, "id": { "type": "string", "format": "uuid" }, "projectId": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "slug": { "type": "string", "maxLength": 256 } }, "required": [ "name", "regions", "settings", "id", "projectId", "dateCreated", "dateUpdated", "slug" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/trackers/{id}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid_trackers_id", "summary": "Delete tracker by ID", "tags": [ "Trackers" ], "description": "Deletes a tracker.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "company": { "oneOf": [ { "type": "string" } ] }, "organization": { "type": "string", "format": "uuid" }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "pattern": { "type": "string" }, "origin": { "type": "string", "description": "Origin of the tracker entry: autoscan (detected by scanning systems) or manual (added directly by a user via the UI or API)", "enum": [ "autoscan", "manual" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organization", "project", "origin", "type" ], "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_privacy_v1_organizations_organizationid_projects_projectid_trackers_id", "summary": "Update tracker", "tags": [ "Trackers" ], "description": "Updates a tracker.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "description": { "oneOf": [ { "type": "string" } ] }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "company": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "pattern": { "type": "string" }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] }, "id": { "not": {} }, "dateCreated": { "not": {} }, "dateUpdated": { "not": {} }, "dateDetected": { "not": {} }, "organization": { "not": {} }, "project": { "not": {} }, "origin": { "not": {} } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "company": { "oneOf": [ { "type": "string" } ] }, "organization": { "type": "string", "format": "uuid" }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "pattern": { "type": "string" }, "origin": { "type": "string", "description": "Origin of the tracker entry: autoscan (detected by scanning systems) or manual (added directly by a user via the UI or API)", "enum": [ "autoscan", "manual" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organization", "project", "origin", "type" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/trackers": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_projects_projectid_trackers", "summary": "Delete one or more trackers", "tags": [ "Trackers" ], "description": "Deletes a single tracker (`{ id }`) or a batch (`{ ids: [...] }`) in one request.", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "ids": { "type": "array", "minItems": 1, "items": { "type": "string", "format": "uuid" } } }, "required": [ "ids" ], "additionalProperties": false } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "company": { "oneOf": [ { "type": "string" } ] }, "organization": { "type": "string", "format": "uuid" }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "pattern": { "type": "string" }, "origin": { "type": "string", "description": "Origin of the tracker entry: autoscan (detected by scanning systems) or manual (added directly by a user via the UI or API)", "enum": [ "autoscan", "manual" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organization", "project", "origin", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "deleted": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "deleted", "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" ] } } } } } }, "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_trackers", "summary": "Get trackers", "tags": [ "Trackers" ], "description": "Gets the trackers for a project.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "in": "query", "name": "type", "required": false }, { "schema": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "in": "query", "name": "category", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "pattern", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "company", "required": false }, { "schema": { "type": "string", "maxLength": 128 }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "description", "required": false }, { "schema": { "type": "string", "enum": [ "autoscan", "manual" ] }, "in": "query", "name": "origin", "required": false, "description": "Origin of the tracker entry: autoscan (detected by scanning systems) or manual (added directly by a user via the UI or API)" }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 1500, "maximum": 2000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "company": { "oneOf": [ { "type": "string" } ] }, "organization": { "type": "string", "format": "uuid" }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "pattern": { "type": "string" }, "origin": { "type": "string", "description": "Origin of the tracker entry: autoscan (detected by scanning systems) or manual (added directly by a user via the UI or API)", "enum": [ "autoscan", "manual" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organization", "project", "origin", "type" ], "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_privacy_v1_organizations_organizationid_projects_projectid_trackers", "summary": "Create new tracker(s)", "tags": [ "Trackers" ], "description": "Create one or more new trackers for the current project.", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "detectedName": { "type": "string", "maxLength": 256 }, "company": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "pattern": { "type": "string", "maxLength": 256 }, "origin": { "type": "string", "default": "manual", "enum": [ "manual", "autoscan" ] }, "matchType": { "type": "string", "enum": [ "new", "project", "global" ] }, "matchedTrackerId": { "oneOf": [ { "type": "string" } ] }, "overrideFields": { "type": "array", "items": { "type": "string", "enum": [ "name", "category", "company", "domain", "description", "expiration" ] } }, "category": { "type": "string", "default": "unclassified", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "name", "type" ], "additionalProperties": false }, { "type": "object", "properties": { "items": { "type": "array", "items": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "detectedName": { "type": "string", "maxLength": 256 }, "company": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "pattern": { "type": "string", "maxLength": 256 }, "origin": { "type": "string", "default": "manual", "enum": [ "manual", "autoscan" ] }, "matchType": { "type": "string", "enum": [ "new", "project", "global" ] }, "matchedTrackerId": { "oneOf": [ { "type": "string" } ] }, "overrideFields": { "type": "array", "items": { "type": "string", "enum": [ "name", "category", "company", "domain", "description", "expiration" ] } }, "category": { "type": "string", "default": "unclassified", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "name", "type" ], "additionalProperties": false } } }, "required": [ "items" ], "additionalProperties": false } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "company": { "oneOf": [ { "type": "string" } ] }, "organization": { "type": "string", "format": "uuid" }, "project": { "type": "string", "format": "uuid" }, "name": { "type": "string", "maxLength": 256 }, "description": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "pattern": { "type": "string" }, "origin": { "type": "string", "description": "Origin of the tracker entry: autoscan (detected by scanning systems) or manual (added directly by a user via the UI or API)", "enum": [ "autoscan", "manual" ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "expiration": { "oneOf": [ { "type": "integer" } ] } }, "required": [ "id", "dateCreated", "dateUpdated", "organization", "project", "origin", "type" ], "additionalProperties": false } } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/tracker-scans": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_projects_projectid_tracker_scans", "summary": "Create new tracker scan", "tags": [ "Tracker Scans" ], "description": "Start a new manual tracker scan for the current project (paid-plans-only; billed per domain scanned).", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "domain": { "type": "string", "minLength": 1, "maxLength": 256 } }, "additionalProperties": false } } } }, "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": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "taskStarted": { "type": "boolean" }, "organizationId": { "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)$" }, "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)$" }, "domainsCount": { "type": "integer", "minimum": 0, "maximum": 9007199254740991 } }, "required": [ "taskStarted", "organizationId", "projectId", "domainsCount" ], "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_privacy_v1_organizations_organizationid_projects_projectid_tracker_scans", "summary": "Delete one or more tracker scan results", "tags": [ "Tracker Scans" ], "description": "Deletes a single tracker scan result (`{ id }`) or a batch (`{ ids: [...] }`) in one request.", "requestBody": { "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" } }, "required": [ "id" ], "additionalProperties": false }, { "type": "object", "properties": { "ids": { "type": "array", "minItems": 1, "items": { "type": "string", "format": "uuid" } } }, "required": [ "ids" ], "additionalProperties": false } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ], "additionalProperties": false }, { "type": "object", "properties": { "deleted": { "type": "integer" }, "ids": { "type": "array", "items": { "type": "string", "format": "uuid" } } }, "required": [ "deleted", "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}/projects/{projectId}/tracker-scan-results": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_projects_projectid_tracker_scan_results", "summary": "Get tracker scan results", "tags": [ "Tracker Scans" ], "description": "Gets the tracker scan results for a project.", "parameters": [ { "schema": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid" } }, { "type": "string", "maxLength": 36 } ] }, "in": "query", "name": "id", "required": false }, { "schema": { "type": "string", "enum": [ "analytics", "do_not_sell", "functional", "global_privacy_control", "limit_pii_use", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "in": "query", "name": "category", "required": false }, { "schema": { "oneOf": [ { "type": "string" } ] }, "in": "query", "name": "company", "required": false }, { "schema": { "oneOf": [ { "type": "string" } ] }, "in": "query", "name": "pattern", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "domain", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "dateDetected", "required": false }, { "schema": { "oneOf": [ { "type": "string" } ] }, "in": "query", "name": "description", "required": false }, { "schema": { "type": "string", "maxLength": 256 }, "in": "query", "name": "name", "required": false }, { "schema": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] }, "in": "query", "name": "type", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "projectDomain", "required": false }, { "schema": { "oneOf": [ { "type": "integer" } ] }, "in": "query", "name": "expiration", "required": false }, { "schema": { "type": "string", "enum": [ "global", "project", "new" ] }, "in": "query", "name": "matchType", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "matchedTrackerId", "required": false }, { "schema": { "type": "boolean" }, "in": "query", "name": "addedToProject", "required": false }, { "schema": { "type": "string", "format": "date-time" }, "in": "query", "name": "dateCreated", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "sort", "required": false }, { "schema": { "type": "string" }, "in": "query", "name": "order", "required": false }, { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "required": false }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "offset": { "type": "integer" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "userAgent": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "pageUrl": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "isBot": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "botMatch": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "addedToProject": { "type": "boolean" }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "company": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "domain": { "oneOf": [ { "type": "string" } ] }, "expiration": { "oneOf": [ { "type": "integer" } ] }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "matchType": { "type": "string", "enum": [ "global", "project", "new" ] }, "matchedTrackerId": { "oneOf": [ { "type": "string" } ] }, "name": { "type": "string", "maxLength": 256 }, "origin": { "type": "string", "enum": [ "site-client", "backend" ] }, "pattern": { "oneOf": [ { "type": "string" } ] }, "projectId": { "type": "string", "format": "uuid" }, "projectDomain": { "oneOf": [ { "type": "string" } ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] } }, "required": [ "addedToProject", "dateCreated", "dateUpdated", "domain", "expiration", "id", "matchType", "matchedTrackerId", "name", "origin", "projectId", "projectDomain", "type" ], "additionalProperties": false } } }, "required": [ "total" ], "additionalProperties": false } } } }, "400": { "description": "Bad request response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "401": { "description": "Unauthorized response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404, "description": "The status code of the request." }, "error": { "type": "string", "default": "Not Found", "description": "The error string for the status code." }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "403": { "description": "Forbidden response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 403, "description": "The status code of the request." }, "error": { "type": "string", "default": "Forbidden" }, "message": { "type": "string", "default": "Forbidden" } }, "required": [ "statusCode", "error", "message" ] } } } }, "404": { "description": "Not found response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 404 }, "error": { "type": "string", "default": "Not Found" }, "message": { "type": "string", "default": "Not Found" } }, "required": [ "statusCode", "error", "message" ] } } } }, "422": { "description": "Unprocessable Entity response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 422 }, "error": { "type": "string", "default": "Unprocessable Entity" }, "message": { "type": "string", "description": "Description of the error encounted." } }, "required": [ "statusCode", "error", "message" ] } } } }, "500": { "description": "Internal server error response.", "content": { "application/json": { "schema": { "type": "object", "properties": { "statusCode": { "type": "integer", "format": "int32", "default": 500 }, "error": { "type": "string", "default": "Internal Server Error" }, "message": { "type": "string", "default": "Internal Server Error", "description": "Will always be \"Internal Server Error\"" } }, "required": [ "statusCode", "error", "message" ] } } } } } } }, "/organizations/{organizationId}/projects/{projectId}/tracker-scans/{id}": { "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_projects_projectid_tracker_scans_id", "summary": "Update tracker scan", "tags": [ "Tracker Scans" ], "description": "Updates a tracker scan result.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "addedToProject": { "type": "boolean" }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "company": { "oneOf": [ { "type": "string" } ] }, "domain": { "oneOf": [ { "type": "string" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "expiration": { "oneOf": [ { "type": "integer" } ] }, "name": { "type": "string", "maxLength": 256 }, "matchType": { "type": "string", "enum": [ "global", "project", "new" ] }, "matchedTrackerId": { "type": "string", "format": "uuid" }, "pattern": { "type": "string" }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "userAgent": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "pageUrl": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "isBot": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "botMatch": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "addedToProject": { "type": "boolean" }, "category": { "type": "string", "enum": [ "analytics", "functional", "marketing", "strictly_necessary", "unclassified", "ignored", "malicious" ] }, "company": { "oneOf": [ { "type": "string" } ] }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "domain": { "oneOf": [ { "type": "string" } ] }, "expiration": { "oneOf": [ { "type": "integer" } ] }, "dateDetected": { "oneOf": [ { "type": "integer" } ] }, "description": { "oneOf": [ { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "matchType": { "type": "string", "enum": [ "global", "project", "new" ] }, "matchedTrackerId": { "oneOf": [ { "type": "string" } ] }, "name": { "type": "string", "maxLength": 256 }, "origin": { "type": "string", "enum": [ "site-client", "backend" ] }, "pattern": { "oneOf": [ { "type": "string" } ] }, "projectId": { "type": "string", "format": "uuid" }, "projectDomain": { "oneOf": [ { "type": "string" } ] }, "type": { "type": "string", "enum": [ "cookie", "script", "iframe", "image", "link", "local_storage", "session_storage" ] } }, "required": [ "addedToProject", "dateCreated", "dateUpdated", "domain", "expiration", "id", "matchType", "matchedTrackerId", "name", "origin", "projectId", "projectDomain", "type" ], "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_privacy_v1_organizations_organizationid_projects_projectid_tracker_scans_id", "summary": "Delete tracker scan result by ID", "tags": [ "Tracker Scans" ], "description": "Deletes a tracker scan result.", "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "projectId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "id", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "deleted": { "type": "boolean" } }, "required": [ "id", "deleted" ], "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}/users/{userId}": { "delete": { "operationId": "delete_privacy_v1_organizations_organizationid_users_userid", "summary": "Delete user", "tags": [ "Users" ], "description": "Deletes a user.", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "userId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "inviteDate": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "accountId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted" ] }, "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "source": { "type": "string", "enum": [ "invite", "owner", "sso-jit", "scim" ] }, "roleManagedByIdp": { "type": "boolean" }, "breakGlass": { "type": "boolean" }, "mfaEnabled": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": false } }, "account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "email", "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" ] } } } } } }, "patch": { "operationId": "patch_privacy_v1_organizations_organizationid_users_userid", "summary": "Update user", "tags": [ "Users" ], "description": "Updates a user.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "breakGlass": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "additionalProperties": false } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "userId", "required": true } ], "responses": { "200": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "inviteDate": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "accountId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted" ] }, "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "source": { "type": "string", "enum": [ "invite", "owner", "sso-jit", "scim" ] }, "roleManagedByIdp": { "type": "boolean" }, "breakGlass": { "type": "boolean" }, "mfaEnabled": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": false } }, "account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "email", "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}/users": { "get": { "operationId": "get_privacy_v1_organizations_organizationid_users", "summary": "Get users", "tags": [ "Users" ], "description": "Gets the users for an Organization.", "parameters": [ { "schema": { "type": "integer", "default": 0, "minimum": 0 }, "in": "query", "name": "offset", "required": false }, { "schema": { "type": "integer", "default": 100, "maximum": 1000 }, "in": "query", "name": "limit", "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" }, "count": { "type": "integer" }, "total": { "type": "integer" }, "items": { "type": "array", "items": { "type": "object", "properties": { "inviteCode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "inviteDate": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "accountId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted" ] }, "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "source": { "type": "string", "enum": [ "invite", "owner", "sso-jit", "scim" ] }, "roleManagedByIdp": { "type": "boolean" }, "breakGlass": { "type": "boolean" }, "mfaEnabled": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": false } }, "account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "email", "organizationId" ], "additionalProperties": false } } }, "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_privacy_v1_organizations_organizationid_users", "summary": "Create user", "tags": [ "Users" ], "description": "Creates a new user in an organization.", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "email": { "type": "string", "format": "email" }, "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId", "role" ], "additionalProperties": false } } }, "required": [ "email" ], "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": { "inviteCode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "inviteDate": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "accountId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted" ] }, "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "source": { "type": "string", "enum": [ "invite", "owner", "sso-jit", "scim" ] }, "roleManagedByIdp": { "type": "boolean" }, "breakGlass": { "type": "boolean" }, "mfaEnabled": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": false } }, "account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "email", "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}/users/{userId}/resend-invite": { "post": { "operationId": "post_privacy_v1_organizations_organizationid_users_userid_resend_invite", "summary": "Resend organization invite", "tags": [ "Users" ], "description": "Resend an organization invite to a user.", "requestBody": { "content": { "application/json": { "schema": { "oneOf": [ { "type": "object" } ] } } } }, "parameters": [ { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "organizationId", "required": true }, { "schema": { "type": "string", "format": "uuid" }, "in": "path", "name": "userId", "required": true } ], "responses": { "201": { "description": "Default Response", "content": { "application/json": { "schema": { "type": "object", "properties": { "inviteCode": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "inviteDate": { "oneOf": [ { "type": "array", "items": {} }, { "type": "boolean" }, { "type": "number" }, { "type": "object" }, { "type": "string" } ] }, "id": { "type": "string", "format": "uuid" }, "dateCreated": { "type": "integer" }, "dateUpdated": { "type": "integer" }, "email": { "type": "string", "format": "email" }, "accountId": { "type": "string", "format": "uuid" }, "organizationId": { "type": "string", "format": "uuid" }, "organizationName": { "type": "string" }, "status": { "type": "string", "enum": [ "pending", "accepted" ] }, "name": { "type": "string", "maxLength": 256 }, "notes": { "type": "string", "maxLength": 1024 }, "source": { "type": "string", "enum": [ "invite", "owner", "sso-jit", "scim" ] }, "roleManagedByIdp": { "type": "boolean" }, "breakGlass": { "type": "boolean" }, "mfaEnabled": { "type": "boolean" }, "permissions": { "type": "array", "items": { "type": "object", "properties": { "projectId": { "type": "string", "format": "uuid" }, "projectName": { "type": "string" }, "role": { "type": "string", "enum": [ "owner", "admin", "limited", "auditor", "guest", "none" ] } }, "required": [ "projectId" ], "additionalProperties": false } }, "account": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid" }, "firstName": { "type": "string" }, "lastName": { "type": "string" }, "email": { "type": "string" }, "phoneNumber": { "type": "string" } }, "additionalProperties": false } }, "required": [ "id", "dateCreated", "dateUpdated", "email", "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" ] } } } } } } } }, "servers": [ { "url": "https://api.concord.tech/privacy-v1", "description": "Concord Privacy API" } ], "security": [ { "ApiKeyAuth": [] } ], "tags": [ { "name": "API Keys", "description": "API Key endpoints." }, { "name": "Consent Events", "description": "Consent event endpoints." }, { "name": "Consent Types", "description": "Consent type endpoints." }, { "name": "Compliance Requests", "description": "Compliance request endpoints." }, { "name": "Data Systems", "description": "Data System endpoints." }, { "name": "Data System Connections", "description": "Data System Connection (data flow) endpoints." }, { "name": "Documents", "description": "Document endpoints." }, { "name": "Domains", "description": "Domain endpoints." }, { "name": "Emails", "description": "Emails endpoints." }, { "name": "Form Submissions", "description": "Form Submission endpoints." }, { "name": "Form Templates", "description": "Form Template endpoints." }, { "name": "GCM Scans", "description": "GCM Scan endpoints." }, { "name": "Health Check", "description": "Health Check endpoints." }, { "name": "Integrations", "description": "Integration endpoints." }, { "name": "Metrics", "description": "Metrics endpoints." }, { "name": "Permissions", "description": "Permission endpoints." }, { "name": "Policies", "description": "Policy endpoints." }, { "name": "Processing Activities", "description": "Processing Activity endpoints." }, { "name": "Projects", "description": "Project endpoints." }, { "name": "Public Keys", "description": "Public Key endpoints." }, { "name": "Compliance Scans", "description": "Compliance Scan endpoints." }, { "name": "Languages", "description": "Language endpoints." }, { "name": "Organizations", "description": "Organization endpoints." }, { "name": "Regions", "description": "Region template endpoints." }, { "name": "ROPA Reports", "description": "ROPA Report endpoints." }, { "name": "Sessions", "description": "Session endpoints." }, { "name": "Trackers", "description": "Tracker endpoints." }, { "name": "Tracker Scans", "description": "Tracker Scan endpoints." }, { "name": "Users", "description": "Users endpoints." }, { "name": "Subscriptions", "description": "Subscription endpoints." }, { "name": "TCF Vendor Management", "description": "TCF Vendor Management endpoints." }, { "name": "TCF Stack Management", "description": "TCF Stack Management endpoints." }, { "name": "TCF Purpose Management", "description": "TCF Purpose Management endpoints." } ] }