Retrieves detailed information about a specific scan iteration in the Borneo integration platform. This endpoint allows users to fetch the current status, results, and metadata associated with a particular scan iteration. It should be used when monitoring the progress of a scan, analyzing results, or troubleshooting integration workflows. The endpoint provides a snapshot of the scan iteration at the time of the request and may not reflect real-time updates if the scan is still in progress. It's particularly useful for auditing, reporting, and maintaining a history of scan operations within Borneo's automation and integration processes.

Adds multiple discovered recipients to the system as confirmed recipients. This endpoint should be used when you have a list of previously discovered recipient IDs that you want to officially add to your recipient database. It's particularly useful for bulk operations where multiple recipients need to be added simultaneously. The endpoint accepts an array of unique UUIDs, allowing for efficient processing of multiple recipients in a single API call. Note that this endpoint only adds recipients; it does not provide any information about the recipients or perform any other actions beyond adding them to the system.

Archives a specific discovered recipient in the Borneo platform. This endpoint is used to move a discovered recipient's data into an archived state, which may be useful for compliance, data retention, or organizational purposes. It should be called when you need to store historical data about a recipient that has been identified through Borneo's data visibility and privacy automation processes. The endpoint uses a POST method, suggesting it may trigger backend processes to properly archive the recipient's data. Note that this operation might affect the visibility or accessibility of the recipient's data in other parts of the system.

The createScan endpoint initiates a new scan operation in the Borneo integration platform, allowing users to configure and schedule data scans across various cloud resources. This powerful tool enables users to set up both one-time and recurring scans, with extensive customization options for resource selection, data inspection policies, and scan limits. It's particularly useful for compliance checks, sensitive data discovery, and regular security audits across cloud environments. The endpoint supports a wide range of resource types and provides flexible scheduling options, from immediate execution to complex cron-based recurring scans. Users should carefully consider the scan configuration to balance thoroughness with resource utilization, especially for large-scale environments. While highly versatile, users should note that some features may be resource-type dependent, and should refer to Borneo's documentation for specific connector and filter support.

Creates a new dashboard user in the Borneo integration platform with specified roles, organizational access, and authentication settings. This endpoint allows for granular control over user permissions across different organizations and departments within the Borneo ecosystem. It supports integration with external identity providers (OKTA or GCP) for authentication. Use this endpoint when onboarding new users or updating existing user permissions. Note that while only the email is required, it's recommended to provide comprehensive role and organization information for proper access control.

Creates a new department in the Borneo integration platform. This endpoint allows you to add a department to the system with support for multilingual information. It's particularly useful when setting up the organizational structure within Borneo or when expanding to new regions requiring localized department names. The endpoint should be used when you need to establish a new department entity that other parts of the system can reference. It's important to note that this endpoint only creates the department and does not associate it with any specific workflows or integrations - those would need to be set up separately.

Creates a new domain within the Borneo integration platform, allowing for automatic polling and management of connected systems or applications. This endpoint is used to set up a new integration point with a specific name and polling frequency. It should be used when establishing a new connection or integration within the Borneo ecosystem. The endpoint is particularly useful for setting up automated data synchronization or workflow triggers between different business applications. It does not provide information about existing domains or modify existing ones; it is strictly for creating new domains.

Creates a new Data Protection Impact Assessment (DPIA) for a specific processing activity in the Borneo application. This endpoint allows users to comprehensively assess and document privacy risks associated with data processing, including confidentiality, integrity, and availability risks. It should be used when initiating a new DPIA process or updating an existing one with detailed risk assessments and mitigation measures. The tool provides a structured approach to evaluating privacy concerns and ensuring compliance with data protection regulations. However, it does not automatically implement any risk mitigation measures; it only facilitates the assessment and documentation process.

Creates a new employee record in the Borneo integration platform. This endpoint allows you to add an employee to the system with various details such as personal information, job-related data, and organizational structure. It's primarily used when onboarding new employees or updating the system with employee information from external sources. The endpoint captures both mandatory fields (name, surname, createdBy) and optional fields for a comprehensive employee profile. It's particularly useful for HR systems integration, allowing synchronization with external APIs through the referenceId field. Note that while it collects employment dates, it doesn't automatically handle employee status changes or departures; these would likely require separate API calls or processes.

Creates a new headquarters entry in the Borneo integration platform. This endpoint allows users to register the main office or primary location of a company or organization within the system. It captures essential information about the headquarters, including its name, address, and associated identifiers. Use this endpoint when setting up a new company profile or updating the primary business location. The endpoint ensures data consistency by enforcing specific formatting rules for each field. It's particularly useful for organizations managing multiple locations or integrating headquarters data with other business systems.

Creates or uploads a new legal document in the Borneo integration platform with specified metadata. This endpoint allows users to add various types of legal documents, such as privacy policies or data processing agreements, to the system. It captures essential information about the document, including its location, type, applicable region, and discovery settings. Use this endpoint when you need to integrate new legal documents into your workflow or update existing ones with new versions. The tool is particularly useful for maintaining a centralized repository of legal documents across different regions and categories within your organization.

Creates a new asset in the Borneo integration platform. This endpoint allows users to add various types of assets to their inventory, ranging from hardware and software applications to office furniture and documentation. It's primarily used when onboarding new resources or updating the asset registry. The endpoint captures essential information about each asset, including its type, location, and associated identifiers. It's particularly useful for organizations managing diverse asset portfolios across multiple locations. Note that while creating an asset, only the name and type are required, allowing for flexible asset management workflows.

Creates a new infotype category in the Borneo integration platform, allowing users to organize and group related sensitive data types. This endpoint is used to establish a structured hierarchy for managing various infotypes, such as PII, PFI, and PHI, enhancing data protection and compliance efforts. The created category serves as a container for specific infotypes, facilitating efficient data classification and management within the Borneo ecosystem.

Creates a new processing activity in the Borneo integration platform. This endpoint allows users to define and configure detailed attributes of a data processing activity, including its purpose, legal basis, data sources, subjects, retention policies, and organizational roles. It's essential for organizations to document their data processing activities for compliance with data protection regulations. Use this endpoint when setting up a new data processing workflow or updating existing processes in your organization's data management strategy.

Creates a new threshold for a specific data processing activity in the context of LOPDP (Law on Personal Data Protection) compliance. This endpoint is used to define and assess various risk factors associated with data processing activities. It allows for the creation of detailed risk profiles by setting multiple boolean flags for different aspects of data processing, such as systematic personal assessment, large-scale observation, and handling of sensitive data. The threshold can be saved as a draft or activated immediately. This tool is essential for organizations to evaluate and document their data processing activities for compliance purposes and risk management.

Creates a new recipient in the Borneo integration platform. This endpoint is used to register and manage detailed information about entities that receive or process data within the system. It captures essential details for compliance with data protection regulations, including the recipient's role, location, data storage information, and associated legal documents like Data Processing Agreements (DPAs). The endpoint is particularly useful for organizations managing complex data ecosystems with multiple partners, vendors, or internal departments. It should be used when onboarding new data recipients or updating existing recipient information to maintain accurate records for auditing and compliance purposes. Note that while many fields are optional, providing comprehensive information enhances the system's ability to manage data flow and compliance effectively.

Creates a new threshold for a specific data processing activity in the Borneo integration platform. This endpoint is used to define and set various characteristics and risk factors associated with a data processing activity, which is crucial for privacy compliance and risk assessment. The threshold creation process captures detailed information about the nature, scope, and potential impact of data processing, allowing organizations to evaluate and manage privacy risks effectively. Use this endpoint when setting up new data processing activities or updating the risk profile of existing ones. The created threshold can be in either 'draft' or 'activated' status, allowing for review before finalizing. Note that while many parameters are optional, providing comprehensive information ensures a more accurate risk assessment.

The DeleteAsset endpoint removes a specific asset from the Borneo integration platform. This operation is used when an asset needs to be permanently deleted from the system, such as when it's no longer relevant or has been decommissioned. The deletion is irreversible, so it should be used with caution. This endpoint is particularly useful for maintaining an up-to-date asset inventory, cleaning up obsolete data, or managing system resources. It's important to note that deleting an asset may have implications on related data or integrations, so users should ensure that the asset is no longer needed before proceeding with deletion.

Deletes a specific category from the Borneo integration platform using its unique label. This endpoint should be used when you need to remove an entire category and all its associated data from the system. It's particularly useful for cleaning up outdated or unnecessary categories. Be cautious when using this endpoint, as the deletion is permanent and cannot be undone. This operation will fail if the specified category doesn't exist or if there are any dependencies preventing its deletion.

Deletes a specific dashboard report from the Borneo integration platform. This endpoint should be used when you need to permanently remove a dashboard report that is no longer needed or relevant. It's important to note that this action is irreversible, and once a report is deleted, it cannot be recovered. Use this endpoint with caution, ensuring that the report is no longer required before deletion. The endpoint does not return the deleted report data, so make sure to retrieve any necessary information before deletion if needed.

Deletes a specific data breach evaluation record from the Borneo system. This endpoint should be used when an organization needs to remove an evaluation record, typically in cases where the record is no longer relevant, contains errors, or needs to be purged for compliance reasons. The operation is irreversible, so it should be used with caution. This tool is part of Borneo's DataBreachManagement functionality, supporting the platform's data protection and privacy management capabilities. It helps maintain an accurate and up-to-date record of data breach evaluations, which is crucial for regulatory compliance and risk management.

Deletes a specific department from the Borneo platform using its unique identifier. This endpoint should be used when you need to remove a department that is no longer relevant or has been decommissioned. It's important to note that this operation is irreversible and will permanently remove all data associated with the specified department. Use this endpoint with caution, as it may impact resource management and organizational structure within the Borneo context. Before deletion, ensure that all necessary data has been backed up or transferred to other relevant departments if required.

Deletes a specific domain from the Borneo integration platform. This endpoint permanently removes all data and configurations associated with the specified domain. Use this operation with caution, as it cannot be undone. It should be used when a domain is no longer needed or when cleaning up unused resources. This operation may have cascading effects on related integrations or workflows, so ensure all dependencies are considered before deletion. The API will likely require appropriate authentication and authorization to perform this sensitive operation.

Deletes a specific Data Protection Impact Assessment (DPIA) from the Borneo system. This endpoint should be used when a DPIA is no longer needed or relevant, such as when a project has been completed or cancelled, or when the assessment needs to be removed due to policy changes. The operation is irreversible, so it should be used with caution. Once deleted, the DPIA and its associated data cannot be recovered through the API. This endpoint is part of Borneo's data privacy management features, allowing organizations to maintain an up-to-date repository of their DPIAs.

Deletes an employee record from the Borneo system using the specified employee ID. This endpoint should be used when an employee leaves the organization or when their record needs to be permanently removed from the system. Once deleted, the employee data cannot be recovered through the API, so use this endpoint with caution. It's recommended to archive or backup employee data before deletion if retention is required for compliance or record-keeping purposes. This operation is final and irreversible within the Borneo platform.

Deletes a specific headquarters record from the Borneo system. This endpoint should be used when you need to permanently remove a headquarters entry from your organization's data. It's particularly useful for cleaning up obsolete or erroneous headquarters data. Exercise caution when using this endpoint, as the deletion is irreversible and will remove all associated data for the specified headquarters. Ensure you have the correct headquarterId before proceeding with the deletion to avoid unintended data loss. This operation may have cascading effects on related data, such as employee records or location-based configurations.

Deletes a specific legal document from the Borneo platform using its unique identifier. This endpoint should be used when a document needs to be permanently removed from the system, such as when it's no longer relevant, outdated, or to comply with data retention policies. It's important to note that this operation is irreversible and should be used with caution. The deletion process ensures compliance with GDPR and FedRAMP standards, maintaining a secure audit trail of the action. Before deletion, ensure that all necessary backups or archival processes have been completed, as the document will no longer be accessible through the system after this operation.

This endpoint deletes a specific LopdP (Local Public Data Protection) threshold from the Borneo integration platform. It is used to remove outdated, incorrect, or no longer applicable thresholds related to data protection regulations. The deletion is permanent and cannot be undone, so it should be used with caution. This endpoint is particularly useful when updating compliance settings or when certain thresholds are no longer relevant due to changes in regulations or business processes. It should not be used for temporary disabling of thresholds; instead, use it only when the threshold needs to be completely removed from the system.

Deletes a specific processing activity from the Borneo integration platform. This endpoint should be used when you need to permanently remove a data processing activity that is no longer required or valid. It's important to note that this action is irreversible, and once a processing activity is deleted, it cannot be recovered. Use this endpoint with caution, as it may impact existing data flows or integrations that depend on the deleted activity. The endpoint does not return the deleted data; it typically returns a success status if the deletion was completed successfully.

Deletes a specific recipient from the Borneo integration platform. This endpoint should be used when you need to permanently remove a recipient's information from the system, such as when a contact is no longer valid or when correcting erroneous entries. The operation is irreversible, so it should be used with caution. Once a recipient is deleted, any associated data or integration settings for that recipient will also be removed. This endpoint is particularly useful for maintaining data hygiene and complying with data retention policies.

The DeleteTags endpoint removes specified tags from resources in the Borneo integration platform. It allows users to delete tags based on their key, and optionally, their value, from a set of resources defined either by a filter or a list of resource IDs. This endpoint is useful for maintaining clean and organized resource tagging, especially when tags become obsolete or need to be updated en masse. It's particularly helpful for bulk tag removal across multiple resources or resource types. However, users should exercise caution as tag deletion is irreversible and may affect resource management and organization within the Borneo platform.

Deletes a specific threshold from the Borneo integration platform. This endpoint should be used when you need to remove a threshold that is no longer required for monitoring or alerting purposes within your integrations. It permanently removes the threshold configuration from the system, so use with caution. This operation cannot be undone, and once a threshold is deleted, any associated alerts or monitoring rules will cease to function. Ensure that the threshold is no longer needed before deletion to avoid disrupting active monitoring processes.

Disables a specified user account in the Borneo dashboard, preventing further access to the system. This endpoint should be used when an administrator needs to revoke a user's access to the Borneo integration platform, such as when an employee leaves the organization or their role changes. The operation is not reversible through this endpoint, so it should be used with caution. Note that disabling a user does not delete their account or associated data; it only restricts their ability to log in and use the dashboard.

The DownloadDashboardReport endpoint allows users to download specific types of dashboard reports from the Borneo integration platform. This POST endpoint is designed to generate and retrieve comprehensive reports related to privacy operations, data discovery, and data flow within an organization's systems. It should be used when detailed insights into data management, privacy compliance, or data flow visualizations are required. The endpoint is particularly useful for privacy officers, data analysts, or system administrators who need to review or present aggregated data on the organization's data handling practices. Note that the report generation process may take some time depending on the complexity and amount of data being analyzed, so users should be prepared for a potential delay before receiving the downloaded report.

Downloads a specific dashboard report edition from the Borneo integration platform. This endpoint allows users to retrieve a particular version or iteration of a dashboard report by providing its unique identifier. It should be used when a user needs to access or save a specific report edition, perhaps for archival purposes, offline analysis, or to compare different versions of a report. The endpoint accepts a POST request with a JSON payload containing the report edition ID. It's important to note that this tool only handles the download process and does not provide functionalities for listing available reports, creating new reports, or modifying existing ones. Users should ensure they have the correct reportEditionId before making the request, as the schema does not specify any error handling for invalid IDs.

Enables dashboard access for a specified user in the Borneo integration platform. This endpoint is used to grant or restore a user's ability to view and interact with dashboards within the system. It should be called when an administrator needs to activate a user's dashboard privileges, such as after initial account creation or if access was previously revoked. The endpoint only handles enabling access and does not provide information about the user's current access status or other account details. Note that this operation does not create a new user account; it assumes the specified username already exists in the system.

This endpoint allows users to evaluate and document details of a data breach incident. It is used to capture comprehensive information about a breach, including notifications made, affected parties, and an overall assessment. The endpoint supports saving evaluations as drafts, enabling users to revisit and complete the documentation process over multiple sessions if needed. The tool should be used when there's a need to record and assess the impact and response to a data breach, whether it's a new incident or an update to an existing evaluation. It's particularly useful for compliance purposes, helping organizations track their breach notification efforts and maintain detailed records of each incident. It's important to note that this endpoint does not automatically notify authorities or affected parties; it merely records whether such notifications have been made. Users should ensure they follow appropriate breach notification procedures separately from using this tool.

The listLeafResources endpoint exports a comprehensive list of leaf resources in the Borneo integration platform, allowing for extensive filtering, sorting, and detailed information retrieval. It's designed to facilitate data discovery, classification, and management across various cloud providers and services. This endpoint is particularly useful for conducting audits, managing data governance, or preparing reports on resource usage and sensitive data distribution across the organization's digital landscape. The function supports a wide range of filtering options, enabling precise querying based on resource attributes, metadata, and detected sensitive information. Users can customize the output by sorting results and requesting detailed column-level information on detected infotypes. While powerful, users should be mindful of potential performance impacts when requesting detailed information or using complex filters on large datasets.

The ExportPageInsight endpoint allows users to export filtered inspection results from a specific scan in the Borneo integration platform. This tool is particularly useful for retrieving and analyzing detailed information about scanned pages, resources, and detected info types. It provides extensive filtering capabilities to customize the exported data according to various criteria such as resource types, user associations, file types, and detection confidence levels. The endpoint should be used when a comprehensive export of scan results is needed, especially for further analysis or reporting purposes. It's important to note that while the filtering options are extensive, the performance may be affected when exporting large datasets with multiple complex filters applied simultaneously.

Exports a filtered and sorted list of inventory resources from the Borneo integration platform. This endpoint allows for extensive customization of the exported data, including pagination, field selection, sorting, and filtering based on various criteria such as account, region, resource type, and tags. It also provides options to include aggregated statistics from child resources, violation metrics, and framework exception counts. Use this endpoint when you need to retrieve a comprehensive, customized view of your inventory resources for analysis, reporting, or integration with other systems. The exported data can be further processed or used for compliance, resource management, or security auditing purposes. Note that the response may be paginated for large result sets, requiring multiple API calls to retrieve all data.

This endpoint exports a filtered list of processing activities in specified formats and languages. It allows users to retrieve data about various data processing activities, which can be customized using multiple filter criteria. The export can be generated in CSV, PDF, or DOC formats, supporting multiple languages for localization. This tool is particularly useful for generating reports, conducting audits, or sharing processing activity information with stakeholders in their preferred format and language. Note that at least one export format and a language must be specified for a successful request.

The ExportRecipientsList endpoint generates and exports a list of recipients based on specified criteria. It allows for flexible data extraction in multiple formats (CSV, PDF, or DOC) with extensive filtering options. This endpoint is ideal for generating reports, performing data analysis, or creating backups of recipient information. It can handle complex queries to narrow down the recipient list based on various attributes such as categories, roles, processing activities, and more. However, it does not provide real-time updates and should be used for point-in-time exports rather than live data access. The endpoint is particularly useful for compliance reporting, auditing, or transferring recipient data to other systems.

Retrieves a specific dashboard report from the Borneo integration platform. This endpoint allows users to access detailed analytics and reporting data for a particular dashboard, providing insights into data exchange, workflow automation, and potentially sensitive data breach information. It should be used when a user needs to view or analyze a specific report's contents, such as performance metrics, data sharing statistics, or privacy incident details. The endpoint is particularly useful for generating up-to-date reports for monitoring and decision-making purposes. Note that this endpoint only retrieves existing reports and does not generate new ones or modify report data.

Retrieves detailed information about a specific evaluated data breach incident. This endpoint should be used when you need to access comprehensive details about a particular data breach that has been assessed within the Borneo platform. It provides insights into the nature, scope, and potential impact of the breach, which can be crucial for incident response, compliance reporting, and risk assessment. The tool is particularly useful for security teams, compliance officers, and data protection officers who need to review or report on specific data breach incidents. Note that this endpoint only provides information about breaches that have already been evaluated and recorded in the system; it cannot be used to report new breaches or assess ongoing incidents.

The InsightListPost endpoint retrieves a list of inspection results from the Borneo integration platform. It allows users to fetch either scan-level or page-level results based on specified criteria. This endpoint is particularly useful for analyzing data security and compliance across various resources and scans. It supports extensive filtering options, pagination for large result sets, and customizable sorting, making it ideal for generating comprehensive reports or conducting detailed investigations into data insights. The endpoint should be used when a detailed overview of inspection results is required, but it may not provide real-time updates for ongoing scans.

The ListAssets endpoint retrieves a customized list of assets from Borneo. It supports flexible filtering and sorting, enabling efficient asset management. Use this endpoint for generating reports, conducting audits, or searching specific items. While powerful, it may not provide detailed asset information in the initial response.

The FilterEmployeeList endpoint allows you to retrieve a filtered list of employees based on specified criteria. This POST operation is designed for querying employee data within the Borneo integration platform, enabling efficient data retrieval for various business processes and integrations. Use this endpoint when you need to fetch a subset of employee records matching particular conditions, such as department, job title, or hire date. The endpoint supports pagination for handling large result sets, making it suitable for applications that need to display or process employee data in manageable chunks. Note that the specific filterable fields may vary depending on your Borneo instance configuration and available employee data.

The FilterRecipientsList endpoint allows users to retrieve a filtered list of recipients based on specified criteria. This POST method endpoint is designed to narrow down a potentially large set of recipients to a more manageable subset that meets certain conditions. It's particularly useful for targeting specific groups of recipients for communication, data analysis, or other operations within the Borneo integration platform. The endpoint supports pagination to handle large result sets efficiently. While it provides powerful filtering capabilities, users should be aware that the performance may vary depending on the complexity of the filter criteria and the size of the recipient database. This endpoint should be used when there's a need to identify and work with a specific subset of recipients rather than the entire list.

Retrieves detailed information about a specific category within Borneo's data classification system using the category's unique label. This endpoint is used to fetch metadata, attributes, and potentially associated data points for a given category. It's particularly useful for understanding the structure and properties of a category, which can be crucial for data governance, compliance reporting, and workflow automation tasks. The endpoint should be used when detailed information about a specific category is needed, such as during data discovery processes, access governance reviews, or when setting up data lineage mappings. It does not modify any data and is primarily for information retrieval purposes.

Retrieves detailed information about a specific cloud account within the Borneo integration platform. This endpoint should be used when you need to access or verify the configuration, status, or properties of a particular cloud account. It provides essential data for account management, such as associated services, integration status, and account-specific settings. This tool is particularly useful for administrators managing multiple cloud accounts or for auditing purposes. Note that it only retrieves information and does not modify the account in any way. The endpoint may not provide sensitive information like access keys or full credential details for security reasons.

Retrieves a specific edition of a dashboard report from the Borneo integration platform. This endpoint is used to fetch detailed information about a particular version of a report, allowing users to access historical data or compare different iterations of the same report. It's particularly useful for tracking changes in business event impacts over time or analyzing data from specific periods. The endpoint should be used when there's a need to review or analyze a specific report edition, rather than just the most recent data. It may not provide real-time updates and is limited to retrieving one report edition at a time.

The FilterDepartmentList endpoint allows users to retrieve a filtered list of departments from the Borneo integration platform. It accepts various filtering criteria to narrow down the results based on department attributes such as name, location, or size. This endpoint is particularly useful for searching specific departments or generating customized department lists for reporting or integration purposes. The filtered results can be sorted and paginated for easier data handling and display. While it provides powerful filtering capabilities, it does not modify any department data and is intended for read-only operations.

Retrieves detailed information about a specific domain within the Borneo integration platform. This endpoint should be used when you need to access the current configuration, status, or other attributes of a particular domain. It provides a comprehensive view of the domain's settings, which can be useful for auditing, troubleshooting, or gathering information for further operations. The endpoint does not modify any domain data and is safe for frequent use. However, it's important to note that this endpoint only retrieves information for a single domain at a time and does not provide aggregated data across multiple domains.

Retrieves detailed information about a specific headquarters registered in the Borneo system. This endpoint allows users to access comprehensive data about an organization's headquarters, which may include its location, data governance practices, compliance status, and security measures. It's particularly useful for auditing purposes, reviewing data management strategies, or assessing the overall data security posture of a specific organizational unit. The endpoint should be used when detailed information about a particular headquarters is needed, especially in the context of data security and governance. It may not provide real-time operational data or information about other organizational units not classified as headquarters.

Retrieves a specific insight from the Borneo platform based on its type and unique identifier. This endpoint is crucial for accessing detailed information about data observability, security, privacy, or compliance issues identified by Borneo's ML-powered classifiers. Use this when you need to fetch comprehensive data about a particular finding, such as sensitive data trends, privacy violations, or security gaps. The endpoint provides focused, in-depth information about a single insight, making it ideal for detailed investigations or generating specific reports. It does not provide aggregated data or lists of multiple insights; for those purposes, you would need to use a different endpoint.

Retrieves detailed inventory information for a specific resource identified by its unique resourceId. This endpoint is designed to provide up-to-date data on the quantity, quality, and status of resources managed by Borneo Resource Investments Ltd., such as mineral deposits or gold mines. It should be used when accurate, current inventory data is needed for resource planning, reporting, or analysis purposes. The endpoint returns comprehensive inventory details, which may include resource quantity, grade, extraction status, and other relevant metrics. However, it does not provide historical inventory data or future projections; it only reflects the current state of the resource inventory.

Retrieves detailed information about a specific data scan performed by Borneo's data risk remediation platform. This endpoint allows users to fetch the results and metadata of a particular scan, including identified sensitive data, compliance status, and any automated tagging applied. It should be used when you need to review the outcome of a specific scan, track the progress of ongoing scans, or audit historical scan data. The endpoint focuses solely on providing scan-related information and does not modify any data or trigger new scans.

Retrieves detailed information about a specific threshold setting in the Borneo integration platform. This endpoint allows users to fetch the configuration and current status of a particular threshold, which may be used for monitoring, alerting, or controlling data flows between integrated systems. It should be used when detailed information about a known threshold is required, such as during system audits, troubleshooting, or when adjusting integration workflows. The endpoint will not modify the threshold settings; it is for retrieval purposes only. Users should ensure they have the correct thresholdId before making the request, as invalid IDs will likely result in error responses.

Retrieves the user profile information for a specific user in the Borneo integration platform. This endpoint should be used when detailed information about a user's profile is needed, such as for displaying user data, verifying user details, or performing user-related operations within the Borneo ecosystem. The endpoint focuses on providing user-specific data while maintaining Borneo's emphasis on data security and privacy observability. It's important to note that this endpoint only retrieves profile information and does not modify or delete user data. The response will likely include various user attributes, but the exact structure and fields are not specified in the given schema.

Lists the editions of a specific dashboard report in the Borneo integration platform. This endpoint allows users to retrieve a paginated list of dashboard report editions, with options for sorting and specifying the number of results per page. It's particularly useful for managing and reviewing multiple versions or iterations of a dashboard report, enabling users to track changes over time or select specific editions for further analysis or comparison. The endpoint supports efficient navigation through large sets of editions using pagination tokens and customizable sorting, making it suitable for applications that need to display or process dashboard report history.

Retrieves a list of dashboard reports from the Borneo integration platform, allowing for filtered, paginated, and sorted results. This endpoint is useful for obtaining an overview of available reports, such as privacy operations dashboards, data discovery dashboards, and privacy ops data flow reports. It supports complex querying through its filter object, enabling users to search by name, type, and frequency. The endpoint facilitates efficient data retrieval through pagination and customizable sorting, making it ideal for applications that need to display or process large sets of report data. Use this when you need to fetch multiple dashboard reports at once, especially when implementing report listing features or performing bulk operations on report data.

Lists and filters dashboard users in the Borneo integration platform based on specified criteria. This endpoint allows retrieval of user data filtered by roles, tenant, organization, and departments. It's useful for user management, access control, and generating reports on user distribution across different organizational units. The endpoint supports complex queries by combining multiple filter criteria, enabling precise user data retrieval for various administrative and analytical purposes.

The ListDataBreaches endpoint retrieves a list of data breaches based on specified filter conditions, allowing for detailed searching and sorting of breach information. It supports pagination for handling large result sets and provides flexible filtering options including free-text search, authority notification status, owner, and breach status. This endpoint is particularly useful for compliance teams, security analysts, and IT administrators who need to monitor, review, or report on data breach incidents within their organization. The tool facilitates efficient data breach management, enabling users to quickly locate specific incidents or generate comprehensive reports based on various criteria.

Retrieves a list of available filter options for data breaches in the Borneo platform. This endpoint allows users to obtain specific filter criteria based on either the owner of the data breach or its current status. It's particularly useful for preparing dynamic filter options in user interfaces or for understanding the range of possible values when filtering data breaches. The endpoint should be called when setting up data breach management dashboards or when implementing search and filter functionality for data breach records. Note that this endpoint only provides filter options and does not return actual data breach information.

The ListDepartments endpoint retrieves a list of departments within the Borneo integration platform. It offers flexible querying with filtering, pagination, and sorting options. Use this endpoint to explore organizational structure, manage department hierarchies, or integrate department information into other systems. Note that it does not support creating, updating, or deleting departments.

Retrieves a list of discovered documents in the Borneo integration platform, allowing for flexible querying, filtering, and sorting of results. This endpoint is used to fetch information about documents that have been discovered by the system, such as newly added files, deleted documents, or items with specific statuses. It supports pagination for handling large datasets and provides sorting capabilities to organize the results according to user preferences. Use this endpoint when you need to review, monitor, or analyze the discovered documents within your Borneo integration environment.

The ListDiscoveredInfoTypes endpoint retrieves discovered info types from Borneo, supporting flexible querying, filtering, sorting, and pagination. It's used for exploring sensitive information identified in your data ecosystem, aiding in data governance and compliance monitoring. The endpoint offers advanced filtering and efficient handling of large datasets.

Lists and retrieves discovered recipients in the Borneo integration platform. This endpoint allows for paginated, sorted, and filtered access to the discovered recipients data. It's designed for efficiently managing and exploring large sets of recipient information, supporting various query parameters for customized result sets. Use this endpoint when you need to browse, search, or analyze discovered recipients based on specific criteria or in a particular order.

Retrieves a list of domains in the Borneo integration platform with support for pagination and custom sorting. This endpoint allows users to fetch domain information in manageable chunks and order the results based on specific criteria. It's particularly useful for applications that need to display or process large sets of domain data efficiently. The endpoint does not provide filtering capabilities, so all domains accessible to the authenticated user will be listed. Use this when you need to enumerate or browse through the domains registered in your Borneo account, such as for administrative purposes or to populate domain selection interfaces.

Retrieves a list of employees based on specified filtering and sorting criteria. This endpoint allows for flexible querying of employee data, supporting both simple and complex search scenarios. It can be used to find employees by name, filter by departments, and sort the results based on various attributes. The endpoint is particularly useful for generating reports, populating employee directories, or performing data analysis on the workforce. It does not modify any employee data and is intended for read-only operations. Note that the response structure and pagination details are not specified in the given schema, so additional documentation may be needed for handling large result sets.

The ErrorList endpoint retrieves errors related to scan iterations in Borneo. It offers flexible filtering, sorting, and pagination for efficient error analysis. Use for debugging, monitoring, or reporting across various scans and resources. Supports up to 10,000 records per call.

Lists and retrieves events based on specified criteria, with options for filtering, sorting, and pagination. This endpoint is designed for querying event data in the Borneo integration platform, allowing users to fetch events related to various entities such as issues, resources, scans, and users. It offers flexible querying capabilities through its filter object, custom sorting, and efficient pagination for handling large datasets. Use this endpoint when you need to search, analyze, or monitor events within your Borneo-integrated systems. The endpoint is particularly useful for generating reports, tracking specific issues, or monitoring system activities across different resources and users.

The ListCategories endpoint allows users to retrieve a list of categories from the Borneo integration platform. It provides flexible options for filtering and sorting the results, enabling efficient category management and exploration. This endpoint is particularly useful when you need to fetch a subset of categories or organize them in a specific order for display or processing purposes. The response will include category information based on the applied filters and sorting criteria. Note that this endpoint does not create, update, or delete categories; it is solely for retrieving existing category data.

Lists the available filters for recipients in the Borneo integration platform based on the specified filter type. This endpoint allows users to retrieve either category-based or role-based filters, which can be used to manage and organize recipients for targeted data distribution or notification purposes. Use this endpoint when you need to access the current set of filters available for recipient management, either by categories or roles. It provides a comprehensive list of filters but does not apply or modify any filters; it's purely for retrieval purposes. This tool is particularly useful for administrators or integrators who need to understand the current filter structure before applying filters to recipients or setting up data distribution rules.

The headquarters_list endpoint retrieves a paginated list of headquarters records from Borneo. It supports efficient querying of large datasets through pagination and custom sorting. This endpoint is ideal for applications needing to display or process headquarters information in batches, such as for reports or dashboards. It offers flexible result retrieval and sorting capabilities, but lacks built-in filtering options.

The list-filters endpoint retrieves a list of available filters for data insights, specifically focused on file extension filters. This tool is used to obtain filtering options for managing and analyzing data within Borneo's integration platform. It's particularly useful when users need to understand or apply filters based on file types in their data streams or integration processes. The endpoint requires a specific scan ID, suggesting that filters are contextual to particular data scans or integration jobs. Currently, the tool is limited to listing file extension filters, which may be used for data categorization, processing, or compliance purposes in data integration workflows.

Retrieves a comprehensive list of resources from Borneo's inventory. Supports detailed filtering, sorting, and pagination for efficient resource management and analysis across multiple cloud providers. Ideal for security auditing, compliance monitoring, and inventory management tasks.

The ListIssues endpoint allows users to retrieve a filtered and sorted list of issues from the Borneo integration platform. It provides extensive filtering capabilities to narrow down results based on various criteria such as resources, cloud accounts, issue states, and severities. The endpoint supports pagination for handling large result sets efficiently and allows customization of the returned data through column selection and inclusion of related resources. This powerful querying tool is essential for monitoring, troubleshooting, and managing issues across integrated systems and cloud environments in Borneo.

The listLeafResources endpoint retrieves and filters leaf resources from Borneo's catalog. It supports detailed searching across various criteria, enabling efficient resource management and discovery. Users can paginate results, include additional information, and sort outputs as needed.

Retrieves a paginated and sortable list of legal documents based on specified filter criteria. This endpoint allows for efficient searching, filtering, and organizing of legal documents within the Borneo integration platform. It supports free-text search on document names, filtering by document status, and custom sorting options. Use this endpoint when you need to fetch multiple legal documents that match specific criteria or when you want to implement a paginated document browsing feature in your application. The endpoint is particularly useful for document management systems, legal workflow automation, or any scenario requiring bulk retrieval of legal document metadata.

The ListRecipients endpoint retrieves a paginated and filtered list of recipients from the Borneo application. It allows for extensive customization of the query through sorting and filtering options, making it suitable for various recipient management and data integration tasks. The endpoint supports pagination for efficient handling of large datasets and provides detailed filtering capabilities to narrow down results based on multiple criteria such as categories, roles, status, and associated entities. This tool is ideal for generating reports, auditing recipient data, or populating user interfaces with recipient information. It should be used when a comprehensive view of recipients is needed, with the ability to apply complex filters and sort the results as required. The endpoint does not modify any data and is solely for retrieval purposes.

ListProcessingActivities retrieves a list of processing activities with extensive filtering, sorting, and pagination. It's ideal for auditing, reporting, or managing data processing activities. The endpoint supports complex querying via the 'filter' object and efficient pagination. While powerful for retrieval, it doesn't modify records.

This endpoint retrieves a list of available filters for processing activities in the PoPS (Processing of Personal Data) Dashboard. It allows users to obtain filter options based on various categories related to data processing activities. The endpoint is designed to support dynamic filtering capabilities in the dashboard, enabling users to refine their view of processing activities according to different criteria. Use this endpoint when you need to populate filter options in the user interface or when preparing to filter the main processing activities list. It's important to note that this endpoint only returns the available filter options and does not perform the actual filtering of processing activities.

The ListScanExecutions endpoint retrieves and filters inspection results from scan executions in the Borneo integration platform. It allows users to query scan results with highly granular control, supporting filtering by scan IDs, resource IDs, infotypes, statuses, and confidence levels. This endpoint is particularly useful for analyzing scan outcomes, tracking specific resources, and managing large datasets through pagination and sorting capabilities. It should be used when you need to review or analyze the results of previous scans, especially when dealing with a large number of scanned resources or when looking for specific types of detected information. The endpoint does not perform new scans; it only retrieves and organizes existing scan results. Keep in mind that the response may be truncated if there are more results than the specified page size, requiring the use of the nextToken for subsequent requests to retrieve all relevant data.

The ListScanIterations endpoint allows users to retrieve a paginated list of scan iterations with customizable filtering, sorting, and field selection options. This POST request is ideal for querying and analyzing scan iteration data across multiple scans or resources. Use it to fetch specific subsets of scan iterations, sort results based on various criteria, and control the amount of data returned in each API call. The endpoint supports efficient pagination for handling large datasets, making it suitable for both small-scale queries and extensive data analysis tasks. It's particularly useful for monitoring scan progress, auditing scan history, or gathering insights across multiple scan iterations.

The list_scans endpoint retrieves a filtered and sorted list of scans from the Borneo integration platform. It allows users to query scan data with extensive filtering options, including search terms, scan types, connector IDs, resources, data planes, and scan statuses. The endpoint supports pagination for handling large result sets and provides control over the returned fields and sorting order. This tool is particularly useful for monitoring scan activities, analyzing scan results across different resources and connectors, and managing large-scale scanning operations in cloud environments.

The ListToms endpoint retrieves a filtered, sorted, and paginated list of toms from the Borneo integration platform. It allows for complex querying of tom objects based on various criteria such as text search, categories, types, statuses, and IDs. The endpoint supports pagination for handling large result sets and provides sorting capabilities for customized data presentation. This tool is ideal for browsing, searching, and analyzing collections of toms within the Borneo system, enabling efficient data exploration and management. It should be used when a comprehensive view of toms is needed, subject to specific filtering and sorting requirements. The endpoint does not create, update, or delete toms; it is purely for retrieval and listing purposes.

The ListUserProfiles endpoint retrieves a paginated and filterable list of user profiles from Borneo. It supports custom querying with search, field selection, sorting, and pagination. Ideal for user management, reporting, and data synchronization tasks. The endpoint offers flexible data retrieval, optimizing for efficiency. Note the 10,000 item limit per request, requiring pagination for larger datasets.

Marks specified reports as false positives within a given scan in the Borneo platform. This endpoint is used to refine scan results by identifying and flagging reports that are determined to be false alarms. It helps in improving the accuracy of security scans and reducing noise in the results. The function takes a scan ID and a list of report UUIDs to be marked as false positives. It should be used when security analysts or automated systems have reviewed scan results and identified certain findings as non-issues or false alarms. This action helps in training the system and improving future scan accuracy. Note that this operation is likely irreversible, so care should be taken to ensure only genuinely false positive reports are marked.

The PauseScan endpoint allows users to temporarily halt an ongoing scan process in the Borneo integration platform. This tool is used to pause the scanning and analysis of sensitive data within connected systems or data streams. It's particularly useful when you need to temporarily suspend data processing for maintenance, to manage system resources, or to address any issues that may have arisen during the scan. The endpoint should be used when there's a need to interrupt a scan without completely terminating it, allowing for later resumption. It's important to note that this action doesn't delete or reset the scan progress; it simply suspends further processing until explicitly resumed. The pause operation is immediate, but any in-progress data processing may complete before the pause takes full effect.

This endpoint allows you to initiate a poll operation or submit data for a specific domain within the Borneo integration platform. It is used when you need to gather information, trigger a data collection process, or update the status of a particular domain identified by its unique domainId. The POST method suggests that you're sending data to the server, possibly to start a new poll, update an existing one, or submit responses to a poll. This endpoint should be used when interacting with domain-specific polling functionality in Borneo, such as collecting integration status updates or triggering scheduled data synchronizations. It's important to note that the exact behavior and data requirements may vary depending on the specific implementation and purpose of polling in your Borneo setup.

The ListAccounts endpoint retrieves a filtered and sorted list of accounts from the Borneo platform. It supports complex querying based on various criteria, offers pagination for large datasets, and allows custom sorting. While providing extensive filtering, it doesn't return detailed account information or support real-time updates.

Retrieves statistical information about resource classifications based on the specified filter criteria. This endpoint allows you to query classification data for resources in the Borneo integration platform. Use this when you need to analyze the distribution or frequency of specific classifications within your integrated data. The endpoint returns aggregated statistics, not individual resource details. It's particularly useful for generating reports, monitoring classification trends, or validating the effectiveness of your classification processes within Borneo.

Retrieves a filtered and sorted list of connectors from the Borneo integration platform. This endpoint allows you to search, filter, and paginate through available connectors based on various criteria such as names, states, types, and associated resources. It's particularly useful for managing large numbers of connectors, monitoring their states, or finding specific connectors within your integration ecosystem. The endpoint supports advanced filtering options, pagination for handling large result sets, and customizable sorting to organize the returned data. Use this when you need to audit your connector inventory, check the status of multiple connectors, or find connectors matching specific criteria.

Retrieves or updates information about the currently authenticated user in the Borneo dashboard. This endpoint is designed to provide or modify user-specific data within the context of the Borneo integration platform's dashboard. It should be used when the application needs to access or update the current user's profile, preferences, or permissions. The endpoint relies on the existing authentication context to identify the user, eliminating the need for additional parameters. It's important to note that this endpoint may not provide general user management functions and is specifically tailored for the authenticated user's dashboard experience.

Creates or schedules a dashboard report in the Borneo integration platform for privacy operations and data discovery. This endpoint allows users to generate various types of reports, including Privacy Ops Dashboard, Data Discovery Dashboard, and Privacy Ops Data Flow. It supports both immediate and scheduled report generation with flexible frequency options. The tool is designed to help organizations track sensitive data, ensure compliance, and manage privacy across their infrastructure. Use this endpoint when you need to set up regular privacy and data discovery reports or generate one-time reports for immediate analysis. Note that the endpoint does not provide real-time data but rather creates reports based on the most recent data available at the time of report generation.

Creates a new data breach report in the Borneo platform. This endpoint allows users to submit comprehensive information about a data breach incident, including details about the occurrence, discovery, affected data and individuals, security measures, and follow-up actions. The report can be saved as a draft or submitted as a final version. It supports multiple languages and allows for the inclusion of additional related information through UUIDs. This tool should be used when documenting and reporting data breach incidents within an organization, helping to ensure compliance with data protection regulations and facilitating incident response and analysis. It's particularly useful for security teams, compliance officers, and data protection officers who need to maintain detailed records of data breaches.

Updates or processes information for a specific discovered recipient user in the Borneo integration platform. This endpoint allows you to interact with user data that has been automatically discovered by the system, potentially as part of the integration process between different applications. Use this when you need to modify, confirm, or take action on a discovered user's information. The exact actions performed depend on the request body (not specified in the schema) but may include tasks such as confirming the user's identity, updating their details, or initiating further integration steps. This endpoint is specific to individual users and requires the unique discoveredRecipientId to target the correct record.

The ListAccessLogs endpoint retrieves and filters access logs from the Borneo integration platform. It allows users to search, filter, and paginate through logs based on various criteria such as user email, operation type, request ID, and time range. This endpoint is essential for monitoring system activity, troubleshooting issues, and maintaining security compliance. Use this endpoint when you need to analyze system usage, track specific user actions, or investigate particular requests or operations. It's particularly useful for auditing purposes, performance monitoring, and identifying patterns or anomalies in system access. The endpoint supports detailed filtering options, allowing for precise log retrieval. However, it's important to note that the results are limited to API logs only, and the maximum number of logs returned per call is capped at 10,000. For comprehensive log analysis, multiple calls may be necessary using the pagination feature.

The RetrieveAuditLogs endpoint fetches filtered audit logs from Borneo. It offers extensive filtering options for precise log retrieval across various cloud platforms and system components. Use it for investigations, troubleshooting, and compliance checks. Supports pagination with a 10,000 entry limit per call.

Retrieves the lineage information for a specified resource within the Borneo integration platform. This endpoint allows users to trace the data flow both upstream and downstream from a given resource, providing crucial insights into data provenance and impact analysis. It's particularly useful for data governance, compliance tracking, and understanding data transformations within your integrated systems. The endpoint requires specifying the resource ID and the depth of lineage to explore in both directions, enabling fine-grained control over the scope of the lineage query. Use this when you need to understand the origin, transformations, and downstream effects of your data resources in Borneo.

Retrieves statistics about resources within the Borneo integration platform. This endpoint provides valuable insights into the current state and usage of resources in your Borneo environment. It can be used to monitor resource utilization, track changes over time, and inform decision-making about resource management and scaling. The endpoint allows for optional inclusion of deleted resources in the statistics, providing flexibility in data analysis. It's particularly useful for administrators and developers who need to understand the overall resource landscape of their Borneo implementation. Note that this endpoint focuses on aggregated statistics and may not provide detailed information about individual resources.

Retrieves and filters the resource status for a specific scan iteration in the Borneo integration platform. This endpoint allows users to fetch detailed information about the status of resources associated with a particular scan, supporting pagination for large datasets and filtering by resource name. It's particularly useful for monitoring the progress of scans, troubleshooting issues with specific resources, or gathering data for reporting purposes. The endpoint should be used when detailed status information about scan resources is required, especially when dealing with large-scale scans that may involve numerous resources. Note that while it supports retrieving up to 10,000 records per call, for very large scans, multiple calls using the nextToken may be necessary to retrieve all data.

The POST /support/chat endpoint handles chat support interactions in Borneo. It processes user queries for real-time assistance with platform issues or inquiries. Use this endpoint to start or continue support conversations, enabling interactive problem-solving within Borneo's ecosystem. Not suitable for non-support communications or large data submissions.

Updates a specific Technical Operating Model (TOM) in the Borneo integration platform. This endpoint allows users to modify the implementation status of a TOM, add explanatory notes, and attach relevant documentation. It's primarily used for tracking and managing the lifecycle of TOMs within an organization's integration processes. The endpoint is particularly useful when the status of a TOM changes, when additional context needs to be provided, or when supporting documents need to be linked to the TOM. It should be used to keep TOM information up-to-date and to maintain a clear record of TOM progress and associated documentation.

Removes a specified user from the dashboard in the Borneo integration platform. This endpoint should be used when you need to revoke a user's access to the dashboard, typically during offboarding processes or when adjusting user permissions. The operation is irreversible, so use it with caution. It only removes the user from the dashboard and does not affect their overall account status in the Borneo platform. This endpoint is particularly useful for administrators managing user access to specific dashboards within the system.

Initiates a password reset process for a specified dashboard user in the Borneo platform. This endpoint should be used when a user has forgotten their password or needs to change it for security reasons. It triggers the password reset mechanism, which typically involves sending a reset link or temporary password to the user's registered email address. This tool does not actually change the password but starts the secure reset process. It's important to note that this endpoint doesn't return the new password or reset token directly for security reasons.

The ResumeDataScan endpoint allows users to resume a previously paused or interrupted data scan operation within the Borneo integration platform. This PUT request is used to continue the scanning process for privacy risks or data vulnerabilities that was halted earlier. The endpoint is particularly useful in scenarios where a scan was temporarily stopped due to system maintenance, network issues, or intentional pausing. It should be used when there's a need to complete an unfinished scan without starting the entire process from the beginning. This tool doesn't initiate new scans or modify the scan parameters; it simply continues the existing scan from where it left off.

Retrieves detailed information for a specific account within the Borneo integration platform. This endpoint should be used when you need to access comprehensive account data, including settings, permissions, integration configurations, and other relevant information associated with the account. It's particularly useful for account management tasks, auditing, or when displaying account details in a user interface. The endpoint returns the most up-to-date information available for the specified account. Note that this endpoint does not provide real-time data security or privacy observability information; for those features, you may need to use separate dedicated endpoints within the Borneo API.

Retrieves detailed information about a specific asset within the Borneo integration platform. This endpoint allows users to fetch comprehensive data about a single asset, including its properties, metadata, and current status. It should be used when detailed information about a particular asset is needed, such as during asset management, auditing, or when integrating asset data with other systems. The endpoint provides a snapshot of the asset's current state and attributes, which can be crucial for decision-making in data governance, security analysis, or integration processes. Note that this endpoint only retrieves information and does not modify the asset in any way. It may not provide historical data or version history of the asset, focusing instead on its current state.

Retrieves detailed information about a specific connector in the Borneo integration platform. This endpoint allows you to fetch the configuration, status, and other relevant details of a connector using its unique identifier. Use this endpoint when you need to inspect or troubleshoot a particular connector's settings or performance. It's particularly useful for administrators or developers managing integrations within the Borneo ecosystem. The endpoint will not modify any connector settings; it's a read-only operation designed for information retrieval only.

Retrieves detailed information about a specific data breach incident using its unique identifier. This endpoint is crucial for investigating and managing data breaches within the Borneo platform. It provides comprehensive details about the breach, which may include the date of occurrence, affected data types, potential impact, and current status of the breach. Use this endpoint when you need in-depth information about a particular data breach for compliance reporting, incident response, or forensic analysis. The endpoint focuses solely on providing information and does not perform any actions or modifications related to the data breach.

Retrieves comprehensive statistical information about data resources across the Borneo integration platform. This endpoint provides valuable insights into the overall data landscape, including metrics related to data security, privacy intelligence, and observability. It should be used when you need a high-level overview of your data resources, including potential security risks, privacy compliance status, and data distribution across integrated systems. The endpoint does not accept any parameters, suggesting it returns a complete snapshot of data stats for all accessible resources. Keep in mind that the response may be extensive and could take longer to process for large-scale integrations with numerous data sources.

Retrieves detailed information about a specific department within the Borneo integration platform. This endpoint is part of the DepartmentsAPI and is used to fetch comprehensive data about a single department, including its configuration, associated workflows, and integration settings. It's particularly useful when you need to review or audit a department's setup within the Borneo ecosystem. The endpoint should be used when detailed information about a specific department is required, such as during troubleshooting, reporting, or when updating department configurations. Note that this endpoint only provides read access to department data and cannot be used to modify department information.

Retrieves detailed information about a specific discovered document within the Borneo system. This endpoint allows users to access metadata, content, or processing status of a document that has been ingested, processed, or otherwise managed by Borneo's document management capabilities. It should be used when detailed information about a particular document is needed, such as during workflow processing, auditing, or information retrieval tasks. The endpoint is particularly useful for tracking the lifecycle of a document within Borneo's ecosystem, from discovery to final processing or archival stages. Note that this endpoint only provides information about a single document; for bulk operations or document listings, a different endpoint would be more appropriate.

Retrieves detailed information about a specific discovered infotype from the Borneo platform. This endpoint is used to access the characteristics, classification, and metadata of a particular data type that has been identified and categorized during the data discovery process. It is particularly useful for understanding the nature of sensitive or important data within your organization's systems. The endpoint should be used when you need to review or analyze the properties of a specific discovered infotype, such as its sensitivity level, applicable compliance rules, or prevalence in your data landscape. It does not modify or create new infotypes; it only provides read access to existing discovered infotype information.

Retrieves detailed information about a specific discovered recipient using their unique identifier. This endpoint is part of the recipient management and discovery process within the Borneo integration platform. It should be used when you need to access comprehensive data about a particular recipient that has been identified or discovered by the system. The endpoint is useful for verifying recipient details, updating records, or integrating recipient information into other workflows. Note that this endpoint only provides information for recipients that have already been discovered and added to the system; it cannot be used to search for new recipients or modify existing recipient data.

Retrieves a specific Data Protection Impact Assessment (DPIA) using its unique identifier. This endpoint is used to access detailed information about a particular DPIA, which is crucial for understanding and managing privacy risks associated with data processing activities in Borneo's conservation and resource management efforts. It should be used when detailed information about a specific DPIA is required, such as for reviewing, updating, or referencing the assessment. The endpoint does not provide a list of all DPIAs or create new ones; it is specifically for retrieving individual DPIA records. Users should ensure they have the correct DPIA identifier before making the request, as incorrect identifiers will likely result in a "not found" error.

Retrieves detailed information for a specific employee within the Borneo integration platform. This endpoint should be used when you need to access comprehensive data about an individual employee, such as their personal details, job information, or any other relevant data stored in the system. It's particularly useful for displaying employee profiles, verifying employee information, or as part of more complex workflows that require up-to-date employee data. The endpoint returns a single employee record based on the provided employee ID. Note that this endpoint only retrieves data and does not modify any employee information. It should not be used for bulk data retrieval or when you need summarized information about multiple employees.

The GetErrorDetails endpoint retrieves detailed information about a specific error in the Borneo integration platform using its unique identifier. This tool is designed to provide comprehensive error data, including error type, description, timestamp, and any associated metadata, which is crucial for effective error management and resolution. It should be used when investigating specific error occurrences, troubleshooting issues, or gathering data for error analysis and reporting. The endpoint is particularly useful for system administrators, developers, and support teams who need to access detailed error information quickly. However, it does not provide aggregated error statistics or perform any error resolution actions; it's purely for fetching individual error details.

Retrieves detailed information about a specific issue in the Borneo system. This endpoint should be used when you need to fetch comprehensive data about a particular issue, such as its current status, associated tasks, or related workflow information. It's particularly useful for tracking the progress of data integration processes, workflow automation tasks, or privacy compliance issues. The endpoint returns a single issue's details and does not provide a list or summary of multiple issues. Note that the exact structure of the returned data is not specified in the given schema, so users should be prepared to handle various fields related to issue management in Borneo's context.

Retrieves a specific legal document from the Borneo system using its unique identifier. This endpoint is designed to access individual legal documents related to Borneo, such as the Native Courts Ordinance, the Malaysia Agreement, or other important legal frameworks and governance documents. It should be used when detailed information about a particular legal document is required. The endpoint returns the full content and metadata of the requested document. It does not provide search functionality or return multiple documents; for those purposes, a separate endpoint would be necessary.

Retrieves detailed information about a specific LOPDP (Logical Object Data Point) threshold configuration within the Borneo integration platform. This endpoint is used to access the settings and parameters of a particular threshold, which are crucial for monitoring system performance and triggering alerts. It should be used when detailed information about a specific threshold's configuration is needed, such as during system audits, troubleshooting, or when adjusting monitoring parameters. The endpoint does not modify any settings; it only provides read access to the existing configuration. Keep in mind that the response will likely include sensitive system configuration data, so access should be restricted to authorized personnel.

Retrieves detailed information about a specific processing activity within the Borneo platform. This endpoint allows users to access comprehensive data related to a particular data processing task or workflow, including its current status, associated metadata, and any relevant compliance information. It is particularly useful for monitoring ongoing activities, auditing past processes, or gathering information for reporting purposes. The endpoint should be used when detailed insights into a single processing activity are required, but it won't provide an overview of multiple activities or system-wide statistics.

Retrieves detailed information about a specific recipient identified by their unique recipientId within the Borneo integration platform. This endpoint is used to fetch comprehensive data about a recipient, which may include personal details, contact information, associated accounts, or any other relevant data stored in the Borneo system. It's particularly useful when you need to access or display a recipient's full profile or verify their information. The endpoint should be used when detailed recipient information is required for operations such as data verification, profile updates, or displaying recipient details in a user interface. Note that this endpoint only provides read access to recipient data and cannot be used to modify recipient information.

Retrieves a paginated list of processing activities associated with a specific recipient in the Borneo integration platform. This endpoint allows you to fetch and navigate through large sets of processing activity data efficiently. It supports sorting and pagination to help manage the volume of data returned. Use this endpoint when you need to review or analyze the processing activities for a particular recipient, such as for compliance audits or data governance purposes. The endpoint does not provide filtering capabilities beyond the recipient ID, so all processing activities for the specified recipient will be included in the results.

Retrieves detailed information about a specific resource from the Borneo catalog using its unique identifier. This endpoint is used to access comprehensive data about a particular resource, which could include metadata, associated files, or other relevant information. It should be used when detailed information about a known resource is required, such as for display purposes or further processing within an integration workflow. The endpoint will not modify the resource or return information about multiple resources. It's important to note that the response structure is not specified in the given schema, so users should refer to Borneo's documentation for the exact format of the returned data.

Retrieves column information for resources in the Borneo integration platform. This endpoint allows users to fetch metadata about the structure of resources, including column names, data types, and potentially other attributes. It's particularly useful when you need to understand the schema of available resources for integration purposes or data analysis. The endpoint returns a comprehensive list of columns across all accessible resources, enabling developers to plan data mappings, transformations, or queries effectively. Note that while this endpoint provides structural information, it does not return the actual data contained within the columns.

Retrieves detailed information about a specific Tom resource using its unique identifier. This endpoint is crucial for accessing individual Tom data within the Borneo integration platform. It should be used when you need to fetch comprehensive details about a particular Tom, such as its configuration, status, or associated metadata. The endpoint is particularly useful for monitoring, updating, or troubleshooting specific Tom instances in your integration workflows. Note that this endpoint only provides information for a single Tom and cannot be used to list or search multiple Toms simultaneously.

Initiates a scanning process for a specified legal document within the Borneo integration platform. This endpoint is used to digitize and process a legal document, making it available for further analysis, storage, or integration with other systems. The scan operation is asynchronous, meaning it will start the scanning process but may not immediately return the results. Use this endpoint when you need to convert a physical or digital legal document into a format that can be easily managed and searched within the Borneo ecosystem. It's particularly useful for automating the intake of new legal documents into the system. Note that this endpoint only initiates the scan and does not provide immediate access to the scanned content; additional API calls may be required to retrieve the processed document or check the scan status.

Stops an ongoing scan operation in the Borneo integration platform. This endpoint allows users to halt a specific scan process that is currently in progress. It should be used when there's a need to interrupt a scan before its natural completion, such as when the scan is taking too long, consuming excessive resources, or if the desired information has already been obtained. The endpoint requires the unique identifier of the scan to be stopped, ensuring precise control over individual scan operations. It's important to note that stopping a scan may result in incomplete data collection or analysis, so it should be used judiciously. This operation is irreversible; once stopped, a scan cannot be resumed and would need to be restarted if further scanning is required.

The SubmitChatFeedback endpoint allows users to provide feedback on a chat support interaction within the Borneo integration platform. This endpoint is crucial for collecting user satisfaction data, which can be used to improve the quality of support and enhance the overall user experience. It should be called after a chat support session has concluded, enabling users to rate their interaction with the support team. The feedback submitted through this endpoint can help Borneo identify areas for improvement in their support processes and recognize high-performing support agents. Note that this endpoint focuses solely on collecting numerical ratings and does not appear to support additional comments or detailed feedback.

Retrieves detailed insights for a specific scan iteration of a particular resource in the Borneo integration platform. This endpoint allows users to access in-depth information about scan results, which can be used for thorough analysis, troubleshooting, or reporting purposes. It's particularly useful when you need to examine the outcomes of a specific scan iteration in detail, either for the entire scan or for a specific page within the scan results. The endpoint requires both the resource and scan iteration identifiers to ensure precise retrieval of the relevant data. Use this when you need comprehensive information about a scan's findings, especially in scenarios involving data quality assessment, integration verification, or system health checks.

Triggers the generation or retrieval of a specific dashboard report in the Borneo integration platform. This endpoint is used to initiate the process of compiling and presenting data for a predefined dashboard report. It's particularly useful when you need to refresh or generate an up-to-date version of a report on demand. The endpoint should be called when a user or system requires the latest data to be reflected in a dashboard report. It's important to note that this endpoint only initiates the report generation process and may not immediately return the report data. Depending on the complexity and size of the report, there might be a processing time before the actual report becomes available.

The UpdateAsset endpoint allows you to modify the details of an existing asset in the Borneo integration platform. This PUT operation at /assets/{assetId} updates the specified asset's information, including its name, type, associated IDs, and location details. It's crucial for maintaining accurate and up-to-date asset records within the system. Use this endpoint when you need to change any attribute of an asset, such as its name, type, or location. The endpoint requires at least the asset's name and type, with options to update additional properties like associated TOM IDs and location information. Note that this operation will overwrite the existing asset data, so include all required fields even if only updating a subset of properties.

Updates the infotypes associated with a specific category in the Borneo integration platform. This endpoint allows you to modify the list of infotypes belonging to a category and optionally update the category's description. It's used for maintaining and organizing the classification of data types within the system, which is crucial for efficient data exchange and workflow automation. The endpoint replaces the entire list of infotypes for the specified category, so it should be used carefully to ensure no unintended removal of existing infotypes. This operation is particularly useful when restructuring data classifications or when new types of information need to be incorporated into existing categories.

Updates the settings of an existing dashboard report in the Borneo integration platform. This endpoint allows you to modify the recipients, roles, and frequency of a specific dashboard report. Use this when you need to change who receives the report, adjust access permissions, or alter the schedule for report generation. The function is particularly useful for maintaining up-to-date distribution lists and ensuring that reports are generated and sent at the most appropriate intervals for your organization's needs. Note that this endpoint only updates the report settings and does not generate or send the report itself.

Updates the information of an existing dashboard user in the Borneo integration platform. This endpoint allows you to modify the name associated with a user's account while maintaining their unique username. It should be used when there's a need to update a user's display name or correct any errors in the existing name. The endpoint requires both the username (for identification) and the new name to be provided. It's important to note that this operation only updates the user's name and does not affect any other user data or permissions.

Updates the roles and department associations for a specified user across multiple organizations in the Borneo dashboard. This endpoint allows administrators to modify a user's access levels and departmental affiliations within the Borneo system. It's particularly useful for managing user permissions when responsibilities change or when adjusting access across different organizations and departments. The endpoint requires specifying the username and at least one organization with assigned roles. Department associations are optional but must be provided as valid UUIDs when included. This tool should be used when there's a need to modify existing user role configurations, not for creating new users or removing users from the system entirely.

The UpdateDataBreach endpoint allows users to create or update detailed information about a specific data breach incident in the Borneo integration platform. This endpoint is crucial for maintaining accurate and comprehensive records of data breach incidents, which is essential for compliance, risk management, and improving security measures. The endpoint captures a wide range of information about the data breach, including its occurrence, discovery, affected parties, potential consequences, and measures taken in response. It provides flexibility by allowing users to save the information as a draft or finalize the report. This endpoint should be used when there's a need to document a new data breach or update existing information about a breach. It's particularly useful for security teams, compliance officers, and risk management professionals who need to maintain detailed records of security incidents.

This endpoint updates the information of an existing department within the Borneo integration platform. It allows you to modify the name of a specific department identified by its unique departmentId. Use this endpoint when you need to rename a department or correct its name in the system. The endpoint is particularly useful for maintaining accurate organizational structure data, which is crucial for workflow automation and integration processes. Note that this operation only updates the department's name and does not affect any other attributes or associations of the department. Ensure that the new name adheres to your organization's naming conventions and accurately represents the department's function.

This endpoint updates the status of a specific discovered document in the Borneo integration platform. It is used as part of the workflow automation process to manage the lifecycle of documents within the system. The endpoint accepts a document ID and a new status, allowing users to change how the document is treated in subsequent processes. This tool should be used when there's a need to modify the processing state of a discovered document, such as marking it for deletion or indicating that it has been successfully added to the system. It's important to note that this endpoint only updates the status and doesn't perform any other operations on the document itself.

Updates the status of a specific discovered infotype in the Borneo integration platform. This endpoint allows users to change the state of an infotype that has been identified during data discovery processes. It is used to manage the lifecycle of discovered infotypes, enabling actions such as approval, ignoring, or deletion. The endpoint should be called when there's a need to change the current status of a discovered infotype, typically as part of data governance or classification workflows. It's important to note that this endpoint only updates the status and doesn't provide additional information about the infotype itself.

Updates the properties of an existing domain within the Borneo integration platform. This endpoint allows you to modify the name and polling frequency of a specific domain identified by its unique domainId. Use this when you need to rename a domain or adjust its automated polling schedule. It's particularly useful for fine-tuning the integration processes or adapting to changing business requirements. The endpoint doesn't provide information about other domain properties or the success of the update operation, so additional verification may be necessary after making changes.

Updates an existing Data Protection Impact Assessment (DPIA) in the Borneo system. This endpoint allows for comprehensive modification of a DPIA's privacy framework, risk assessments (confidentiality, integrity, and availability), and associated metadata. It's used to refine and complete a DPIA throughout its lifecycle, from draft to activation. The tool supports detailed documentation of privacy principles, risk analyses, and mitigation measures. It's particularly useful for privacy professionals and data protection officers managing complex data processing activities. Note that activating a DPIA requires filling in numerous mandatory fields, ensuring a thorough privacy impact assessment.

Updates the information of an existing employee in the Borneo integration platform. This endpoint allows you to modify various details of an employee's record, including personal information, job-related data, and organizational relationships. It's primarily used for maintaining up-to-date employee records, reflecting changes in positions, departments, or personal details. The endpoint requires the employee's unique identifier and accepts a JSON object containing the updated information. While it offers flexibility in updating multiple fields, it's important to note that the email address must remain unique within the company. This tool should be used whenever there are changes to an employee's information that need to be reflected in the system, but should not be used for creating new employee records or for bulk updates.

Updates the information for an existing headquarter in the Borneo integration platform. This endpoint allows you to modify various details of a headquarter, such as its name, address, and associated Tom IDs. It should be used when there are changes to a headquarter's information or when correcting existing data. The endpoint requires the headquarter's unique identifier and accepts a JSON payload with the updated information. It enforces strict validation rules to ensure data integrity and consistency across the platform. Note that while some fields are optional, others (name, city, address, and country) are mandatory and must be provided with each update request.

Updates the LOPDP (Likely Operational Privacy Data Protection) threshold settings for a specific threshold identified by the lopdpThresholdId. This endpoint allows you to modify various data protection and privacy compliance parameters related to data processing activities. Use this endpoint when you need to adjust risk assessments, update processing characteristics, or change the status of a threshold. The endpoint is crucial for maintaining up-to-date privacy impact assessments and ensuring compliance with data protection regulations. Note that this endpoint only updates the threshold settings and does not perform any actual data processing or risk mitigation actions.

This endpoint updates an existing processing activity in a data privacy management system. It modifies details about personal data processing, crucial for compliance with regulations like GDPR. Use it to update activity status, purpose, legal basis, data subjects, and more. Only 'active' and 'name' fields are required, but providing comprehensive information is recommended for accurate records.

Updates the information of an existing recipient in the Borneo integration platform. This endpoint allows you to modify various details of a recipient, including their name, business information, status, categories, roles, and data protection-related information. It's used when you need to change or update any aspect of a recipient's profile, such as updating their DPA status, changing their role, or modifying their data storage locations. This endpoint is particularly useful for maintaining up-to-date records of your business partners and ensuring compliance with data protection regulations. Note that some fields are required and must be included in every update request, while others are optional and can be omitted if no changes are needed.

Updates the status and automation status of a specific recipient in the Borneo integration platform. This endpoint allows users to modify a recipient's overall status (archived or validated) and their automation status (ignored, created, or new). It's particularly useful for managing recipient data lifecycle and controlling how recipients are handled in automated workflows. The endpoint should be used when there's a need to change a recipient's status due to changes in their relevance or to adjust their interaction with automated processes. It's important to note that this endpoint only updates status information and does not modify other recipient details.

Updates an existing threshold in the Borneo integration platform with new settings and information related to data processing and compliance. This endpoint allows you to modify various aspects of a threshold, including its status, comments, and multiple boolean flags that define the characteristics of the data processing activities. Use this endpoint when you need to adjust the parameters of a threshold to reflect changes in data handling practices, compliance requirements, or to activate a draft threshold. The endpoint is particularly useful for maintaining up-to-date records of data processing activities and ensuring compliance with data protection regulations. Note that updating a threshold does not automatically apply the changes to ongoing data processing; it may require additional steps to implement the updated settings in your data workflows.

Completes the email verification process for a user account in the Borneo integration platform. This endpoint is called when a user clicks on the verification link sent to their email address. It validates the provided verificationId and token to confirm the user's email address. This is a crucial step in the user authentication workflow, ensuring that users have provided valid email addresses and helping to prevent unauthorized access. The endpoint should only be used once per verification attempt, as tokens are typically single-use and time-limited for security reasons. Note that this endpoint doesn't handle the initial request for email verification or resending verification emails; it's specifically for completing the verification process.