{"openapi":"3.0.0","paths":{"/api/v1/security/external-scans":{"get":{"operationId":"SecurityApiExternalScansController_getExternalScanAssessments","parameters":[{"required":false,"description":"Search query string","name":"search","in":"query","schema":{"type":"string"}},{"required":false,"description":"Field to sort by","name":"assessmentSortBy","in":"query","schema":{"default":"createdAt","allOf":[{"$ref":"#/components/schemas/AssessmentSortBy"}]}},{"required":false,"description":"Sort order","name":"sortOrder","in":"query","schema":{"default":"DESC","allOf":[{"$ref":"#/components/schemas/SortOrder"}]}},{"required":false,"description":"Pagination offset","name":"offset","in":"query","schema":{"type":"number"}},{"required":false,"description":"Maximum results to return","name":"limit","in":"query","schema":{"default":100,"type":"number"}}],"responses":{"200":{"description":"The external scan assessments are successfully listed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalScansDTO"}}}}},"security":[{"oauth2":[]},{"ApiKey":[]},{"bearer":[]}],"summary":"Get all external scans","tags":["External Scans"]},"post":{"operationId":"SecurityApiExternalScansController_addExternalScanAssessment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalScanCreateDTO"}}}},"responses":{"201":{"description":"The external scan assessment has been successfully created.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalScanDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Create an external scan","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}":{"get":{"operationId":"SecurityApiExternalScansController_getExternalScanAssessment","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"The external scan assessment data is fetched.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalScanDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get external scan by ID","tags":["External Scans"]},"put":{"operationId":"SecurityApiExternalScansController_editExternalScanAssessment","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalScanCreateDTO"}}}},"responses":{"200":{"description":"The external scan assessment has been successfully updated.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExternalScanDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Update an external scan","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}/findings":{"get":{"operationId":"SecurityApiExternalScansController_getExternalScanAssessmentFindings","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"The external scan assessment findings data is fetched.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecurityFindingDTO"}}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get external scan findings","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}/rescan-all":{"post":{"operationId":"SecurityApiExternalScansController_markApplicationRescanAll","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeepScanEventDTO"}}}},"responses":{"200":{"description":"The assessment is marked for rescan."}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Rescan all devices for assessment","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}/uninstall-all":{"post":{"operationId":"SecurityApiExternalScansController_markApplicationUninstallAll","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeepScanEventDTO"}}}},"responses":{"200":{"description":"The application is marked for uninstall."}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Uninstall all devices for assessment","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}/breach-data":{"get":{"operationId":"SecurityApiExternalScansController_getBreachData","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}}],"responses":{"200":{"description":"The breach data is fetched.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/BreachDataDTO"}}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get breach data for assessment","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}/findings/{slug}":{"get":{"operationId":"SecurityApiExternalScansController_getExternalScanFindings","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}},{"name":"slug","required":true,"in":"path","description":"Finding Slug","schema":{"type":"string"}}],"responses":{"200":{"description":"The external scan assessment finding data is fetched.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/SecurityFindingDetailDTO"}}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get external scan finding details by slug","tags":["External Scans"]}},"/api/v1/security/external-scans/{id}/report":{"get":{"operationId":"SecurityApiExternalScansController_generateExternalScanReport","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment ID","schema":{"type":"string"}},{"name":"detailed","required":false,"in":"query","description":"Generate detailed report","schema":{"default":false,"type":"boolean"}},{"name":"format","required":false,"in":"query","description":"Report file format","schema":{"$ref":"#/components/schemas/ReportFormat"}},{"required":false,"description":"Generate detailed report","name":"detailed","in":"query","schema":{"default":false,"type":"boolean"}},{"required":false,"description":"Report file format","name":"format","in":"query","schema":{"default":"pdf","allOf":[{"$ref":"#/components/schemas/ReportFormat"}]}}],"responses":{"200":{"description":"The external scan assessment report is downloaded.","content":{"application/octet-stream":{}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Download external scan report","tags":["External Scans"]}},"/api/v1/security/risk-assessments/{id}/convert-to-risk-assessment":{"post":{"operationId":"SecurityApiRiskAssessmentsController_convertToRiskAssessment","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully converted application to a risk assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Convert application to risk assessment","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/monitoring-settings":{"patch":{"operationId":"SecurityApiRiskAssessmentsController_updateApplicationSettings","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentUpdateMonitoringDTO"}}}},"responses":{"200":{"description":"Successfully updated risk monitoring configuration for the assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Update monitoring settings for risk assessment","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getRiskAssessments","parameters":[{"required":false,"name":"search","in":"query","schema":{"type":"string"}},{"required":false,"name":"scanStatus","in":"query","schema":{"type":"array","items":{"$ref":"#/components/schemas/RiskAssessmentStatus"}}},{"required":false,"name":"assessmentSortBy","in":"query","schema":{"default":"createdAt","allOf":[{"$ref":"#/components/schemas/AssessmentSortBy"}]}},{"required":false,"name":"sortOrder","in":"query","schema":{"default":"DESC","allOf":[{"$ref":"#/components/schemas/SortOrder"}]}},{"required":false,"name":"offset","in":"query","schema":{"type":"number"}},{"required":false,"name":"limit","in":"query","schema":{"default":100,"type":"number"}}],"responses":{"200":{"description":"Successfully retrieved risk assessments based on query parameters.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentsDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get all risk assessments","tags":["Risk Assessments"]},"post":{"operationId":"SecurityApiRiskAssessmentsController_addRiskAssessment","parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentCreateDTO"}}}},"responses":{"201":{"description":"Successfully created a new light scan risk assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Create a risk assessment","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getRiskAssessment","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved detailed risk assessment data including security scan information when available.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get risk assessment by ID","tags":["Risk Assessments"]},"put":{"operationId":"SecurityApiRiskAssessmentsController_editRiskAssessment","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentCreateDTO"}}}},"responses":{"200":{"description":"Successfully updated organization and domain information for the risk assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RiskAssessmentDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Update a risk assessment","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/domain-change-preview":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getDomainChangePreview","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Preview of data that will be affected by a domain change.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DomainChangePreviewDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/devices":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getAllDeepScanDevices","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved all scan targets associated with this assessment.","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/DeepScanTargetDTO"}}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get all devices for risk assessment","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/devices/{deviceId}":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getDeepScanTarget","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}},{"name":"deviceId","required":true,"in":"path","description":"Deep Scan Target UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved detailed information for the specified scan target.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DeepScanTargetDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get device by ID","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/devices/{deviceId}/rescan":{"post":{"operationId":"SecurityApiRiskAssessmentsController_rescanDeepScanTarget","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}},{"name":"deviceId","required":true,"in":"path","description":"Deep Scan Target UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully initiated a rescan for the specified target device."}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Rescan device","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/scan-status":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getScanStatus","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Scan completion status summary for all devices in the assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssessmentScanStatusDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get scan completion status for all devices in a risk assessment","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/report":{"get":{"operationId":"SecurityApiRiskAssessmentsController_generateRiskAssessmentReport","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}},{"required":false,"name":"reportType","in":"query","schema":{"default":"telivy_complete_report_pdf","allOf":[{"$ref":"#/components/schemas/ReportType"}]}}],"responses":{"200":{"description":"Successfully generated and delivered risk assessment report as a downloadable file.","content":{"application/octet-stream":{}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Download risk assessment report","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/m365-users":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getM365Users","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"M365 user data including account status, MFA, login failures. Returns configured=false if M365 is not connected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/M365UsersResponseDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get M365 user accounts with login status and MFA info","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/gws-users":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getGwsUsers","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"Google Workspace user data including account status, 2SV, login activity. Returns configured=false if GWS is not connected.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GwsUsersResponseDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get Google Workspace user accounts with login and 2SV status","tags":["Risk Assessments"]}},"/api/v1/security/risk-assessments/{id}/pii-summary":{"get":{"operationId":"SecurityApiRiskAssessmentsController_getPiiSummary","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}}],"responses":{"200":{"description":"PII distribution by type and device, with aggregate risk values.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PiiSummaryDataDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"summary":"Get PII exposure summary across all devices","tags":["Risk Assessments"]}},"/api/v1/security/{id}/risk":{"get":{"operationId":"SecurityController_getRiskProgressReport","parameters":[{"name":"id","required":true,"in":"path","description":"Assessment UUID","schema":{"type":"string"}},{"name":"currentTimestampGroup","required":true,"in":"query","description":"The current/most recent scan timestamp","schema":{"type":"string"}},{"name":"compareWithTimestampGroup","required":false,"in":"query","description":"The scan timestamp to compare against (defaults to previous scan if not provided)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved risk progress report for the assessment.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindingsProgressReportResponseDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"tags":["security"]}},"/api/v1/security/agent-versions":{"get":{"operationId":"SecurityController_getLatestAgentVersions","parameters":[],"responses":{"200":{"description":"Successfully retrieved the latest available agent versions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AgentVersionsDTO"}}}}},"security":[{"ApiKey":[]},{"oauth2":[]},{"bearer":[]}],"tags":["security"]}},"/api/v1/security/findings/{slug}":{"get":{"operationId":"SecurityController_getFindingDetailsBySlug","parameters":[{"name":"slug","required":true,"in":"path","description":"Finding slug (e.g., TYPO_SQUATTING, PERSONAL_EMAILS)","schema":{"type":"string"}}],"responses":{"200":{"description":"Successfully retrieved finding details for the given slug.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SecurityFindingDTO"}}}}},"tags":["security"]}}},"info":{"title":"Telivy Security API","description":"

Telivy Security APIs for Managed Service Providers (MSPs). Manage external scans, risk assessments, and security findings programmatically.

\n \n

Authentication

\n

Telivy uses Auth0 for secure authentication. To access the API, you'll need an MSP account on our platform.

\n

New to Telivy? Contact us to create a free account.

\n\n

OAuth2 Authentication

\n

Obtain an access token by completing the login flow:

\n

Start OAuth2 Login Flow

\n\n

API Key Authentication

\n

Include your API key in the x-api-key header with each request.

\n

Find your API key in the Telivy Portal → Account → Integrations.

\n\n

OpenAPI Schema

\n

Download the OpenAPI 3.0 specification for code generation and API tooling:

\n

https://api-v1.telivy.com/api-docs/security-json

\n","version":"1.0","contact":{}},"tags":[],"servers":[{"url":"https://api-v1.telivy.com"}],"components":{"securitySchemes":{"ApiKey":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key authentication"},"oauth2":{"type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://auth.telivy.com/authorize?audience=telivy-agent-portal&client_id=xY0dmr0qR6slpPOWDyHY7FFt6VuZCdKH","scopes":{}}},"description":"OAuth2 authentication via Auth0"},"bearer":{"scheme":"bearer","bearerFormat":"JWT","type":"http","description":"JWT Bearer token authentication"}},"schemas":{"AssessmentSortBy":{"type":"string","enum":["organizationName","assessmentStatus","createdAt","updatedAt"],"description":"Field to sort by"},"SortOrder":{"type":"string","enum":["DESC","ASC"],"description":"Sort order"},"ExternalScanStatus":{"type":"string","enum":["not_started","in_progress","completed","archived"],"description":"Current scan status"},"OrganizationAddressDTO":{"type":"object","properties":{"street":{"type":"string","description":"Street address"},"unit":{"type":"string","description":"Unit or suite number"},"city":{"type":"string","description":"City"},"state":{"type":"string","description":"State or province"},"zip_code":{"type":"string","description":"ZIP or postal code"}},"required":["street","city","state","zip_code"]},"AssessmentDetailsDTO":{"type":"object","properties":{"organization_name":{"type":"string","description":"Organization name"},"domain_prim":{"type":"string","description":"Primary domain"},"organization_address":{"description":"Organization address","allOf":[{"$ref":"#/components/schemas/OrganizationAddressDTO"}]},"contact_first_name":{"type":"string","description":"Contact first name"},"contact_last_name":{"type":"string","description":"Contact last name"},"contact_email":{"type":"string","description":"Contact email address"},"business_phone":{"type":"string","description":"Business phone number"},"annual_revenue":{"type":"number","description":"Annual revenue"},"employee_count":{"type":"number","description":"Employee count"},"primary_operations":{"type":"string","description":"Primary business operations"}},"required":["organization_name","domain_prim","organization_address","contact_first_name","contact_last_name","contact_email","business_phone","annual_revenue","employee_count","primary_operations"]},"SecurityGrade":{"type":"string","enum":["A","B","C","D","F","n/a"],"description":"Overall security score grade"},"SecurityGradesDTO":{"type":"object","properties":{"socialEngineering":{"nullable":true,"description":"Social engineering security grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"networkSecurity":{"nullable":true,"description":"Network security grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"applicationSecurity":{"nullable":true,"description":"Application security grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"dnsHealth":{"nullable":true,"description":"DNS health grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"ipReputation":{"nullable":true,"description":"IP reputation grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"externalVulnerabilities":{"nullable":true,"description":"External vulnerabilities grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]}},"required":["socialEngineering","networkSecurity","applicationSecurity","dnsHealth","ipReputation","externalVulnerabilities"]},"ExternalScanDTO":{"type":"object","properties":{"id":{"type":"string","description":"External scan ID"},"scanStatus":{"description":"Current scan status","allOf":[{"$ref":"#/components/schemas/ExternalScanStatus"}]},"assessmentDetails":{"description":"Assessment details","allOf":[{"$ref":"#/components/schemas/AssessmentDetailsDTO"}]},"securityScore":{"description":"Overall security score grade","allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"lastScannedAt":{"format":"date-time","type":"string","nullable":true,"description":"Last scan timestamp"},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","description":"Last update timestamp"},"grades":{"description":"Security grades by category","allOf":[{"$ref":"#/components/schemas/SecurityGradesDTO"}]}},"required":["id","scanStatus","assessmentDetails","securityScore","createdAt","updatedAt"]},"ExternalScansDTO":{"type":"object","properties":{"message":{"type":"string","description":"Response status message"},"assessments":{"description":"List of external scan assessments","type":"array","items":{"$ref":"#/components/schemas/ExternalScanDTO"}},"total":{"type":"number","description":"Total count of assessments"}},"required":["message","assessments","total"]},"ClientCategory":{"type":"string","enum":["breakfix","it_only","security_only","it_and_security"],"description":"Client category"},"ClientStatus":{"type":"string","enum":["suspect","lead","client"],"description":"Client status"},"ExternalScanCreateDTO":{"type":"object","properties":{"organizationName":{"type":"string","description":"Organization name"},"domain":{"type":"string","description":"Primary domain to scan"},"clientCategory":{"nullable":true,"description":"Client category","allOf":[{"$ref":"#/components/schemas/ClientCategory"}]},"clientStatus":{"nullable":true,"description":"Client status","allOf":[{"$ref":"#/components/schemas/ClientStatus"}]}},"required":["organizationName","domain"]},"SecuritySeverity":{"type":"string","enum":["critical","high","medium","low","info"],"description":"Severity level"},"SecurityFindingDTO":{"type":"object","properties":{"name":{"type":"string","description":"Finding name"},"slug":{"type":"string","description":"Finding slug identifier"},"description":{"type":"string","description":"Finding description"},"risk":{"type":"string","description":"Risk description"},"recommendation":{"type":"string","description":"Remediation recommendation"},"references":{"description":"Reference links","type":"array","items":{"type":"string"}},"scanType":{"type":"string","description":"Type of security scan"},"severity":{"description":"Severity level","allOf":[{"$ref":"#/components/schemas/SecuritySeverity"}]}},"required":["name","scanType","severity"]},"DeepScanEventDTO":{"type":"object","properties":{"reason":{"type":"string"}}},"BreachDataDTO":{"type":"object","properties":{"id":{"type":"string"},"securityScanId":{"type":"string"},"domainName":{"type":"string"},"sourceId":{"type":"string"},"breachName":{"type":"string","nullable":true},"lastBreach":{"type":"string","nullable":true},"email":{"type":"string"},"ipAddress":{"type":"string","nullable":true},"userName":{"type":"string","nullable":true},"password":{"type":"string"},"hashedPassword":{"type":"string","nullable":true},"hashType":{"type":"string","nullable":true},"name":{"type":"string","nullable":true},"address":{"type":"string","nullable":true},"phone":{"type":"string","nullable":true},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","securityScanId","domainName","sourceId","breachName","lastBreach","email","ipAddress","userName","password","hashedPassword","hashType","name","address","phone","createdAt","updatedAt"]},"SecurityFindingStatus":{"type":"string","enum":["open","in_review","resolved","accepted"],"description":"Finding status"},"SecurityFindingDetailDTO":{"type":"object","properties":{"id":{"type":"string","description":"Finding ID"},"domain":{"type":"string","description":"Domain where finding was detected"},"slug":{"type":"string","description":"Finding slug identifier"},"scanType":{"type":"string","description":"Type of security scan"},"severity":{"description":"Severity level","allOf":[{"$ref":"#/components/schemas/SecuritySeverity"}]},"value":{"type":"string","description":"Finding value or details"},"status":{"description":"Finding status","allOf":[{"$ref":"#/components/schemas/SecurityFindingStatus"}]},"comment":{"type":"string","description":"User comment"},"devLogs":{"type":"string","description":"Development logs"},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","description":"Last update timestamp"}},"required":["id","domain","slug","scanType","severity","value","status","comment","devLogs","createdAt","updatedAt"]},"ReportFormat":{"type":"string","enum":["pdf","docx"]},"RiskAssessmentStatus":{"type":"string","enum":["not_started","in_progress","report_completed","archived"]},"MonitoringFrequency":{"type":"string","enum":["DISABLE","QUARTERLY","MONTHLY","WEEKLY"]},"ExecutiveSummaryScore":{"type":"object","properties":{"securityScore":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/SecurityGrade"}]},"summary":{"type":"string"}},"required":["securityScore"]},"ExecutiveSummaryDTO":{"type":"object","properties":{"networkSecurity":{"$ref":"#/components/schemas/ExecutiveSummaryScore"},"dataSecurity":{"$ref":"#/components/schemas/ExecutiveSummaryScore"},"applicationSecurity":{"$ref":"#/components/schemas/ExecutiveSummaryScore"},"identityAccessManagement":{"$ref":"#/components/schemas/ExecutiveSummaryScore"},"darkWebPresence":{"$ref":"#/components/schemas/ExecutiveSummaryScore"},"m365Security":{"$ref":"#/components/schemas/ExecutiveSummaryScore"},"gwsSecurity":{"$ref":"#/components/schemas/ExecutiveSummaryScore"}},"required":["networkSecurity","dataSecurity","applicationSecurity","identityAccessManagement","darkWebPresence","m365Security","gwsSecurity"]},"RiskAssessmentDTO":{"type":"object","properties":{"id":{"type":"string"},"telivyKey":{"type":"string"},"scanStatus":{"allOf":[{"$ref":"#/components/schemas/RiskAssessmentStatus"}]},"assessmentDetails":{"$ref":"#/components/schemas/AssessmentDetailsDTO"},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"},"monitoringEnabled":{"type":"boolean"},"monitoringFrequency":{"allOf":[{"$ref":"#/components/schemas/MonitoringFrequency"}]},"executiveSummary":{"$ref":"#/components/schemas/ExecutiveSummaryDTO"}},"required":["id","telivyKey","scanStatus","assessmentDetails","createdAt","updatedAt","monitoringEnabled"]},"RiskAssessmentUpdateMonitoringDTO":{"type":"object","properties":{"monitoringFrequency":{"nullable":true,"description":"The frequency of monitoring for the risk assessment. Use null to disable monitoring.","allOf":[{"$ref":"#/components/schemas/MonitoringFrequency"}]}},"required":["monitoringFrequency"]},"RiskAssessmentsDTO":{"type":"object","properties":{"message":{"type":"string"},"assessments":{"type":"array","items":{"$ref":"#/components/schemas/RiskAssessmentDTO"}},"total":{"type":"number"}},"required":["message","assessments","total"]},"PiiCountry":{"type":"string","enum":["US","CA","UK","ZA","AU","NZ","SG","PL"]},"RiskAssessmentCreateDTO":{"type":"object","properties":{"organizationName":{"type":"string"},"domain":{"type":"string"},"country":{"default":"US","allOf":[{"$ref":"#/components/schemas/PiiCountry"}]},"clientCategory":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ClientCategory"}]},"clientStatus":{"nullable":true,"allOf":[{"$ref":"#/components/schemas/ClientStatus"}]},"antiVirus":{"type":"string"},"cleanupDomainChange":{"type":"boolean"},"isLightScan":{"type":"boolean"}},"required":["organizationName","domain"]},"DomainChangePreviewDTO":{"type":"object","properties":{"findingsCount":{"type":"number"},"tasksCount":{"type":"number"},"syncedTicketsCount":{"type":"number"},"alertsCount":{"type":"number"}},"required":["findingsCount","tasksCount","syncedTicketsCount","alertsCount"]},"DeepScanTargetDTO":{"type":"object","properties":{"id":{"type":"string"},"hostname":{"type":"string"},"macAddress":{"type":"string"},"osVersion":{"type":"string"},"telivyAgentInstalledAt":{"type":"string"},"telivyAgentUninstalledAt":{"type":"string"},"lastHeartBeatAt":{"type":"string"},"status":{"type":"string"},"scanCompleted":{"type":"boolean","description":"Whether all scans for this device have completed"},"agentVersion":{"type":"string","nullable":true},"createdAt":{"format":"date-time","type":"string"},"updatedAt":{"format":"date-time","type":"string"}},"required":["id","hostname","macAddress","osVersion","telivyAgentInstalledAt","telivyAgentUninstalledAt","lastHeartBeatAt","status","scanCompleted","agentVersion","createdAt","updatedAt"]},"DeviceScanStatusSummary":{"type":"object","properties":{"deviceId":{"type":"string","description":"Device UUID"},"hostname":{"type":"string","description":"Device hostname"},"status":{"type":"string","description":"Current scan status (e.g. install-success, install-in-progress)"},"scanCompleted":{"type":"boolean","description":"Whether all scans for this device have completed"}},"required":["deviceId","hostname","status","scanCompleted"]},"AssessmentScanStatusDTO":{"type":"object","properties":{"totalDevices":{"type":"number","description":"Total number of devices in the assessment"},"completedDevices":{"type":"number","description":"Number of devices that have completed scanning"},"inProgressDevices":{"type":"number","description":"Number of devices still scanning or pending"},"allScansCompleted":{"type":"boolean","description":"True when all devices have completed scanning (also true when there are no devices)"},"devices":{"description":"Per-device scan status breakdown","type":"array","items":{"$ref":"#/components/schemas/DeviceScanStatusSummary"}}},"required":["totalDevices","completedDevices","inProgressDevices","allScansCompleted","devices"]},"ReportType":{"type":"string","enum":["executive_security_summary_pdf","telivy_complete_report_pdf","telivy_complete_report_docx","telivy_external_scan_report_pdf","telivy_network_inventory_report_csv","internal_vulnerabilities_top_pdf","internal_vulnerabilities_executive_pdf","internal_vulnerabilities_network_pdf","internal_vulnerabilities_detailed_csv","applications_security_overview_csv","applications_security_detailed_csv","data_security_sensitive_documents_csv","data_security_detailed_risk_xlsx","telivy_passwords_report_csv","telivy_passwords_reuse_report_csv","telivy_dark_web_report_csv","m365_security_report_pdf","m365_security_data_report_xlsx","gws_security_report_pdf","gws_security_data_report_xlsx","legacy_complete_report_pdf"]},"CloudConnectionStatus":{"type":"string","enum":["connected","token_error","needs_reauth","disconnected"]},"M365UserLoginFailureDTO":{"type":"object","properties":{"createdDateTime":{"type":"string"},"appDisplayName":{"type":"string"},"ipAddress":{"type":"string"},"clientAppUsed":{"type":"string"},"errorCode":{"type":"number"},"failureReason":{"type":"string"}},"required":["createdDateTime","appDisplayName","ipAddress","clientAppUsed","errorCode","failureReason"]},"M365UserDTO":{"type":"object","properties":{"id":{"type":"string"},"displayName":{"type":"string"},"mail":{"type":"string","nullable":true},"userPrincipalName":{"type":"string"},"accountEnabled":{"type":"boolean"},"hasMfa":{"type":"boolean"},"authenticationMethods":{"type":"array","items":{"type":"string"}},"lastSignInDateTime":{"type":"string","nullable":true},"lastNonInteractiveSignInDateTime":{"type":"string","nullable":true},"isInactive":{"type":"boolean"},"jobTitle":{"type":"string","nullable":true},"recentLoginFailures":{"type":"array","items":{"$ref":"#/components/schemas/M365UserLoginFailureDTO"}}},"required":["id","displayName","mail","userPrincipalName","accountEnabled","hasMfa","authenticationMethods","lastSignInDateTime","lastNonInteractiveSignInDateTime","isInactive","jobTitle","recentLoginFailures"]},"M365UsersDataDTO":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/M365UserDTO"}},"totalUsers":{"type":"number"},"usersWithMfa":{"type":"number"},"usersWithoutMfa":{"type":"number"},"disabledAccounts":{"type":"number"},"inactiveAccounts":{"type":"number"},"totalLoginFailures":{"type":"number"}},"required":["users","totalUsers","usersWithMfa","usersWithoutMfa","disabledAccounts","inactiveAccounts","totalLoginFailures"]},"M365UsersResponseDTO":{"type":"object","properties":{"message":{"type":"string","description":"Optional response message for operation status"},"configured":{"type":"boolean","default":false},"connectionStatus":{"nullable":true,"default":null,"allOf":[{"$ref":"#/components/schemas/CloudConnectionStatus"}]},"data":{"nullable":true,"default":null,"type":"object","allOf":[{"$ref":"#/components/schemas/M365UsersDataDTO"}]},"lastSyncedAt":{"format":"date-time","type":"string","nullable":true,"default":null}},"required":["configured","connectionStatus","data","lastSyncedAt"]},"GwsLoginActivityDTO":{"type":"object","properties":{"email":{"type":"string"},"ipAddress":{"type":"string"},"timestamp":{"format":"date-time","type":"string"},"eventNames":{"type":"array","items":{"type":"string"}},"city":{"type":"string","nullable":true},"countryOrRegion":{"type":"string","nullable":true}},"required":["email","ipAddress","timestamp","eventNames","city","countryOrRegion"]},"GwsUserDTO":{"type":"object","properties":{"id":{"type":"string"},"primaryEmail":{"type":"string"},"fullName":{"type":"string"},"isAdmin":{"type":"boolean"},"isDelegatedAdmin":{"type":"boolean"},"suspended":{"type":"boolean"},"archived":{"type":"boolean"},"isEnrolledIn2Sv":{"type":"boolean"},"isEnforcedIn2Sv":{"type":"boolean"},"lastLoginTime":{"format":"date-time","type":"string","nullable":true},"creationTime":{"format":"date-time","type":"string"},"isInactive":{"type":"boolean"},"changePasswordAtNextLogin":{"type":"boolean"},"isMailboxSetup":{"type":"boolean"},"recentLoginActivity":{"type":"array","items":{"$ref":"#/components/schemas/GwsLoginActivityDTO"}}},"required":["id","primaryEmail","fullName","isAdmin","isDelegatedAdmin","suspended","archived","isEnrolledIn2Sv","isEnforcedIn2Sv","lastLoginTime","creationTime","isInactive","changePasswordAtNextLogin","isMailboxSetup","recentLoginActivity"]},"GwsUsersDataDTO":{"type":"object","properties":{"users":{"type":"array","items":{"$ref":"#/components/schemas/GwsUserDTO"}},"totalUsers":{"type":"number"},"adminAccounts":{"type":"number"},"suspendedAccounts":{"type":"number"},"inactiveAccounts":{"type":"number"},"enrolledIn2Sv":{"type":"number"},"notEnrolledIn2Sv":{"type":"number"}},"required":["users","totalUsers","adminAccounts","suspendedAccounts","inactiveAccounts","enrolledIn2Sv","notEnrolledIn2Sv"]},"GwsUsersResponseDTO":{"type":"object","properties":{"message":{"type":"string","description":"Optional response message for operation status"},"configured":{"type":"boolean","default":false},"connectionStatus":{"nullable":true,"default":null,"allOf":[{"$ref":"#/components/schemas/CloudConnectionStatus"}]},"data":{"nullable":true,"default":null,"type":"object","allOf":[{"$ref":"#/components/schemas/GwsUsersDataDTO"}]},"lastSyncedAt":{"format":"date-time","type":"string","nullable":true,"default":null}},"required":["configured","connectionStatus","data","lastSyncedAt"]},"PiiTypeDistributionDTO":{"type":"object","properties":{"piiType":{"type":"string"},"filesCount":{"type":"number"},"matchesCount":{"type":"number"},"totalRisk":{"type":"number"}},"required":["piiType","filesCount","matchesCount","totalRisk"]},"PiiDeviceSummaryDTO":{"type":"object","properties":{"hostname":{"type":"string"},"filesScanned":{"type":"number"},"sensitiveFiles":{"type":"number"},"totalRisk":{"type":"number"}},"required":["hostname","filesScanned","sensitiveFiles","totalRisk"]},"PiiSummaryDataDTO":{"type":"object","properties":{"distributionByType":{"type":"array","items":{"$ref":"#/components/schemas/PiiTypeDistributionDTO"}},"deviceSummaries":{"type":"array","items":{"$ref":"#/components/schemas/PiiDeviceSummaryDTO"}},"totalSensitiveFiles":{"type":"number"},"totalDataRisk":{"type":"number"}},"required":["distributionByType","deviceSummaries","totalSensitiveFiles","totalDataRisk"]},"ScanTimestampsDTO":{"type":"object","properties":{"fromScanTimestamp":{"type":"string"},"toScanTimestamp":{"type":"string"}},"required":["fromScanTimestamp","toScanTimestamp"]},"FindingAdditionalDataType":{"type":"string","enum":["cve"],"description":"Data type discriminator"},"CveAdditionalDataDTO":{"type":"object","properties":{"type":{"description":"Data type discriminator","allOf":[{"$ref":"#/components/schemas/FindingAdditionalDataType"}]},"id":{"type":"string","description":"CVE ID"},"title":{"type":"string","description":"CVE title"},"description":{"type":"string","description":"CVE description"},"score":{"type":"number","description":"CVSS score"},"foundIn":{"type":"object","properties":{"product":{"type":"string"},"version":{"type":"string"}},"required":["product","version"]}},"required":["type"]},"DiskEncryptionAdditionalDataDTO":{"type":"object","properties":{"type":{"description":"Data type discriminator","allOf":[{"$ref":"#/components/schemas/FindingAdditionalDataType"}]},"MountPoint":{"type":"string","description":"Mount point path"},"FileSystem":{"type":"string","description":"File system type"},"IsEncrypted":{"type":"boolean","description":"Whether disk is encrypted"}},"required":["type","MountPoint","IsEncrypted"]},"BrowserPasswordAdditionalDataDTO":{"type":"object","properties":{"type":{"description":"Data type discriminator","allOf":[{"$ref":"#/components/schemas/FindingAdditionalDataType"}]},"breached":{"type":"boolean","description":"Whether password was found in breach database"},"browsers":{"description":"List of browsers where password was found","type":"array","items":{"type":"string"}}},"required":["type","breached","browsers"]},"ConnectedPortDTO":{"type":"object","properties":{"port":{"type":"number","description":"Port number"},"potentialServices":{"type":"string","description":"Potential services running on this port"}},"required":["port","potentialServices"]},"DeviceScanDataDTO":{"type":"object","properties":{"connectedPorts":{"description":"Connected ports","type":"array","items":{"$ref":"#/components/schemas/ConnectedPortDTO"}}}},"OpenPortsAdditionalDataDTO":{"type":"object","properties":{"type":{"description":"Data type discriminator","allOf":[{"$ref":"#/components/schemas/FindingAdditionalDataType"}]},"data":{"description":"Device scan data","allOf":[{"$ref":"#/components/schemas/DeviceScanDataDTO"}]}},"required":["type"]},"GenericAdditionalDataDTO":{"type":"object","properties":{"type":{"description":"Data type discriminator","allOf":[{"$ref":"#/components/schemas/FindingAdditionalDataType"}]},"data":{"type":"object","description":"Additional properties","additionalProperties":true}},"required":["type"]},"FindingValue":{"type":"object","properties":{"id":{"type":"string","description":"Finding value ID"},"value":{"type":"string","description":"Raw value"},"formattedValue":{"type":"string","description":"Formatted value for display","nullable":true},"valueHash":{"type":"string","description":"Value hash for deduplication"},"additionalData":{"type":"object","description":"Additional data specific to finding type","nullable":true,"oneOf":[{"$ref":"#/components/schemas/CveAdditionalDataDTO"},{"$ref":"#/components/schemas/DiskEncryptionAdditionalDataDTO"},{"$ref":"#/components/schemas/BrowserPasswordAdditionalDataDTO"},{"$ref":"#/components/schemas/OpenPortsAdditionalDataDTO"},{"$ref":"#/components/schemas/GenericAdditionalDataDTO"}],"discriminator":{"propertyName":"type","mapping":{"cve":"#/components/schemas/CveAdditionalDataDTO","disk_encryption":"#/components/schemas/DiskEncryptionAdditionalDataDTO","browser_password":"#/components/schemas/BrowserPasswordAdditionalDataDTO","open_ports":"#/components/schemas/OpenPortsAdditionalDataDTO","generic":"#/components/schemas/GenericAdditionalDataDTO"}}},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp"}},"required":["id","value","formattedValue","valueHash","additionalData","createdAt"]},"TaskSourceType":{"type":"string","enum":["TELIVY","TENTACLE","RISK_DECISION"],"description":"Source system type"},"TaskStatus":{"type":"string","enum":["OPEN","IN_PROGRESS","RESOLVED","CLOSED"],"description":"Task status"},"TaskResponseDTO":{"type":"object","properties":{"message":{"type":"string","description":"Optional response message for operation status"},"id":{"type":"string","description":"Task ID"},"applicationId":{"type":"string","description":"Application ID"},"sourceType":{"description":"Source system type","allOf":[{"$ref":"#/components/schemas/TaskSourceType"}]},"sourceEntityId":{"type":"string","description":"Source entity ID"},"sourceEntityMeta":{"type":"object","nullable":true,"description":"Source entity metadata"},"status":{"description":"Task status","allOf":[{"$ref":"#/components/schemas/TaskStatus"}]},"title":{"type":"string","description":"Task title"},"description":{"type":"string","description":"Task description"},"recommendation":{"type":"string","nullable":true,"description":"Recommendation"},"technicalDetails":{"type":"string","nullable":true,"description":"Technical details"},"taskNumber":{"type":"string","description":"Task number"},"resolutionTargetDate":{"type":"string","nullable":true,"description":"Resolution target date","format":"date-time"},"createdAt":{"format":"date-time","type":"string","description":"Created at timestamp"},"updatedAt":{"format":"date-time","type":"string","description":"Updated at timestamp"}},"required":["id","applicationId","sourceType","sourceEntityId","sourceEntityMeta","status","title","description","recommendation","technicalDetails","taskNumber","resolutionTargetDate","createdAt","updatedAt"]},"FindingDecisionType":{"type":"string","enum":["ACCEPTED","RESOLVED_COMPENSATING_CONTROL"]},"DecisionUserDTO":{"type":"object","properties":{"email":{"type":"string"}},"required":["email"]},"FindingDecisionResponseDTO":{"type":"object","properties":{"message":{"type":"string","description":"Optional response message for operation status"},"id":{"type":"string"},"decisionType":{"allOf":[{"$ref":"#/components/schemas/FindingDecisionType"}]},"findingFingerprint":{"type":"string"},"applicationId":{"type":"string"},"reason":{"type":"string"},"userId":{"type":"string"},"user":{"nullable":true,"type":"object","allOf":[{"$ref":"#/components/schemas/DecisionUserDTO"}]},"expiresAt":{"type":"string","format":"date-time"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"}},"required":["id","decisionType","findingFingerprint","applicationId","reason","userId","user","expiresAt","createdAt","updatedAt"]},"FindingWithTaskResponseDTO":{"type":"object","properties":{"id":{"type":"string","description":"Finding ID"},"timestampGroup":{"type":"string","description":"Timestamp group for finding grouping (e.g., weekly)"},"identifier":{"type":"string","nullable":true,"description":"Source identifier (device ID, domain name, or cloud identifier)"},"slug":{"type":"string","description":"Finding slug identifier"},"value":{"description":"Finding value with additional data","allOf":[{"$ref":"#/components/schemas/FindingValue"}]},"valueId":{"type":"string","description":"Finding value ID"},"applicationId":{"type":"string","description":"Application ID"},"createdAt":{"format":"date-time","type":"string","description":"Creation timestamp"},"updatedAt":{"format":"date-time","type":"string","description":"Last update timestamp"},"task":{"description":"Task linked to the finding, when applicable","allOf":[{"$ref":"#/components/schemas/TaskResponseDTO"}]},"source":{"type":"string","description":"Finding source type"},"decision":{"description":"Finding decision if present","allOf":[{"$ref":"#/components/schemas/FindingDecisionResponseDTO"}]},"cisCategory":{"type":"string","description":"CIS category when available"},"controlId":{"type":"string","description":"Control identifier when available"}},"required":["id","timestampGroup","identifier","slug","value","valueId","applicationId","createdAt","updatedAt"]},"ProgressReportDTO":{"type":"object","properties":{"new":{"type":"array","items":{"$ref":"#/components/schemas/FindingWithTaskResponseDTO"}},"resolved":{"type":"array","items":{"$ref":"#/components/schemas/FindingWithTaskResponseDTO"}},"regressed":{"type":"array","items":{"$ref":"#/components/schemas/FindingWithTaskResponseDTO"}},"open":{"type":"array","items":{"$ref":"#/components/schemas/FindingWithTaskResponseDTO"}}},"required":["new","resolved","regressed","open"]},"FindingsProgressReportResponseDTO":{"type":"object","properties":{"message":{"type":"string","description":"Optional response message for operation status"},"scans":{"$ref":"#/components/schemas/ScanTimestampsDTO"},"report":{"$ref":"#/components/schemas/ProgressReportDTO"}},"required":["scans","report"]},"AgentVersionsDTO":{"type":"object","properties":{"windows":{"type":"string"},"mac":{"type":"string"}},"required":["windows","mac"]}}}}