Borneo

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.

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 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.