Borneo
borneoBorneo is a data security and privacy platform designed for sensitive data discovery and remediation.
Acciones disponibles (153)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
Access scan iteration by idBORNEO_ACCESS_SCAN_ITERATION_BY_IDAcciónRetrieves 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.
BORNEO_ACCESS_SCAN_ITERATION_BY_IDAcciónRetrieves 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.
Parámetros de entrada
scanIterationIdstringObligatorioThe unique resource ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Add discovered recipientsBORNEO_ADD_DISCOVERED_RECIPIENTSAcciónAdds 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.
BORNEO_ADD_DISCOVERED_RECIPIENTSAcciónAdds 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.
Parámetros de entrada
discoveredRecipientIdsstring[]ObligatorioIdentifiers of the discovered recipients to add as recipients.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Archive discovered recipientBORNEO_ARCHIVE_DISCOVERED_RECIPIENTAcciónArchives 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.
BORNEO_ARCHIVE_DISCOVERED_RECIPIENTAcciónArchives 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.
Parámetros de entrada
discoveredRecipientIdstringObligatorioIdentifier of the discovered recipient.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete data breach by idBORNEO_BORNEO_DELETE_DATA_BREACH_BY_IDAcciónDeletes 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.
BORNEO_BORNEO_DELETE_DATA_BREACH_BY_IDAcciónDeletes 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.
Parámetros de entrada
dataBreachIdstringObligatorioDatabreachid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create and schedule cloud resource scanBORNEO_CREATE_AND_SCHEDULE_CLOUD_RESOURCE_SCANAcciónThe 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.
BORNEO_CREATE_AND_SCHEDULE_CLOUD_RESOURCE_SCANAcciónThe 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.
Parámetros de entrada
cronstringenumThe cron schedule expression to use for a recurring scan. Only a fixed set of cron expressions can be used to run scans at 30 minute, 1 hour, 1 day, or 1 week intervals.
*/30 * * * *0 */1 * * *0 */12 * * *0 */4 * * *0 */6 * * *0 */8 * * *0 0 * * *0 0 * * 00 0 1 * *0 0 1 1,4,7,10 *0 0 1 1,7 *namestringThe name of the scan.
scanTypestringenumThe type of scan to perform, i.e. either full scan or sample scan.
fullsamplescanFilterobject[]Filter conditions to apply to the scan.
connectorIdstringThe ID of the connector to use for the scan. The connector type must match the resource type.
resourceTypestringThe type of resource to scan.
scheduleTypestringObligatorioenumA schedule type of "once" indicates that the scan will be executed once immediately at the time it is created or once as per the scheduled calendar time. A schedule type of "cron" creates a recurring scan that will be executed at the specified cron schedule.
crononceresources__allbooleanSet this to `true` to determine the set of resources to scan based on the filter conditions in the `resources` property. If set to `false`, a static set of `resourceIds` must be specified.
resources__namestring[]Name
resources__tagsobject[]Filter the resources which have teh tags
resources__regionstringThe region of the cloud account to which the resoure belongs.
resources__schemastring[]Filter the resources with the list of schemas for selected connector types
resources__searchstringFree-text search on the resource name.
resources__teamIdstringSlack Workspace id in Slack Enterprise Connector
resources__datasetstring[]Filter the resources with the list of datasetss for selected connector types
resources__driveIdstring[]Filter the resources with the list of driveIds for gdrive connector types
resources__regionsstring[]List of regions to which the resoure belongs to in that cloud account.
resources__teamUrlstringSlack Workspace URL in Slack Enterprise Connector
schedule__timezonestringtime zone to be considered for the schedule
resources__databasestring[]Filter the resources with the list of databaseses for selected connector types
resources__isPublicbooleanFilter the resources which are public.
resources__parentIdstringFilter the resources which has the specified parent id.
resources__teamNamestringSlack Workspace name in Slack Enterprise Connector
schedule__calendarsobject[]List of schedules
resources__accountIdstringThe account ID of the cloud account to which the resoure belongs. E.g. a 12-digit AWS account ID.
resources__driveTypestring[]Filter the resources with the list of driveTypes for gdrive connector types
resources__isPrivatebooleanPrivate channels, for Slack Enterprise Connector
resources__orgUnitIdstring[]Filter the resources with the list of orgUnits for gdrive connector types
resources__spaceTypestring[]Filter conlfluences based on type
resources__isArchivedbooleanFilter the channels marked as archived for Slack connector types
resources__isExternalbooleanFilter the channels marked as external for Slack connector types
resources__resourceIdsstring[]One or more resource IDs to return.
resources__spaceStatusstring[]Filter conlfluences based on status
resources__googleGroupsstring[]Googlegroups
resources__resourceTypestringFilter the resources based on the resource type.
resources__isUnencryptedbooleanFilter the resources which are un-unencrypted.
resources__infoTypes__opsstringenumOps
ANDORresources__zendeskGroupIdinteger[]Zendeskgroupid
scanLimits__itemsPerBatchintegerMaximum number of item (records, objects, etc.) to scan per resource. Supported for sample scans on the following resource types: S3, DynamoDB, PostgreSQL, MySQL, Presto, MongoDB, BigQuery, Cassandra.
inspectionPolicy__infotypesstring[]List of infotypes to scan for. If empty, all enabled infotypes will be included.
inspectionPolicy__compliancestring[]List of infotype categories to scan for. All enabled infotypes included in the specified categories will be used in the scan. If `infotypes` is also specified, this list of infotype categories will be ignored.
scanLimits__samplePercentageintegerPercentage of data to scan per resource. Supported for full scans on the following resource types: S3, BigQuery.
inspectionPolicy__maskDetailsbooleanIf true, the matched tokens captured as part of the detailed scan results will be masked. If false, the raw, unmasked tokens will be captured. Use with caution. Only applicable if `detailed` scan results are enabled.
inspectionPolicy__collectTokensbooleanIf true, the scan will capture details about every infotype match, including the matched token, and exact location of the token. If false, the scan will capture only aggregate results (a.k.a. "snapshot" results).
resources__infoTypes__infoTypesstring[]The list of infotypes to filter on.
resources__isSlackDirectMessagesbooleanFetch DMs, for Slack Enterprise Connector
scanLimits__sampleDurationMinutesintegerSampledurationminutes
scanLimits__maxCumulativeDataSizeMbintegerMaximum data size to scan per resource in MB. Supported for full scans on the following resource types: PostgreSQL, MySQL.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create dashboard userBORNEO_CREATE_DASHBOARD_USERAcciónCreates 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.
BORNEO_CREATE_DASHBOARD_USERAcciónCreates 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.
Parámetros de entrada
namestringName
emailstringObligatorioEmail
rolesstring[]Roles
filter__idstringId
filter__typestringenumType
GCPOKTAorganisationsobject[]Organisations
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create department with translationsBORNEO_CREATE_DEPARTMENT_WITH_TRANSLATIONSAcciónCreates 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.
BORNEO_CREATE_DEPARTMENT_WITH_TRANSLATIONSAcciónCreates 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.
Parámetros de entrada
namestringName
translationsobjectTranslations
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create domain with polling frequencyBORNEO_CREATE_DOMAIN_WITH_POLLING_FREQUENCYAcciónCreates 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.
BORNEO_CREATE_DOMAIN_WITH_POLLING_FREQUENCYAcciónCreates 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.
Parámetros de entrada
namestringObligatorioName of the domain.
frequencystringObligatorioenumFrequency of polling for a domain. Manual polling means that this domain will not be polled automatically.
12h1d1w30d6hmanual
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create dpia for processing activityBORNEO_CREATE_DPIA_FOR_PROCESSING_ACTIVITYAcciónCreates 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.
BORNEO_CREATE_DPIA_FOR_PROCESSING_ACTIVITYAcciónCreates 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.
Parámetros de entrada
statusstringObligatorioenumThe status of the DPIA. If a DPIA is saved as activated, several fields are required
activateddraftcreatedAtintegerCreatedat
updatedAtintegerUpdatedat
translationsobjectTranslations
integrity__impactsobject[]List of impacts that integrity risk can have. At least one element is necessary DPIA is saved as activated
integrity__threatsobject[]List of threats that integrity risk can have. At least one element is necessary DPIA is saved as activated
processingActivityIdstringObligatorioIdentifier of the processing activity for which we are creating a DPIA
additionalInformationstringAdditionalinformation
availability__impactsobject[]List of impacts that availability risk can have. At least one element is necessary DPIA is saved as activated
availability__threatsobject[]List of threats that availability risk can have. At least one element is necessary DPIA is saved as activated
integrity__plannedTomsstring[]List of TOMs that are planned to be implemented to prevent integrity risk. At least one element is necessary DPIA is saved as activated
integrity__riskSourcesobject[]List of risk sources that integrity risk can have. At least one element is necessary DPIA is saved as activated
confidentiality__impactsobject[]List of impacts that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
confidentiality__threatsobject[]List of threats that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
availability__plannedTomsstring[]List of TOMs planned to be implemented and that applies to the availability risk. At least one element is necessary DPIA is saved as activated
availability__riskSourcesobject[]List of risk sources that availability risk can have. At least one element is necessary DPIA is saved as activated
integrity__impactsCommentstringComment to add additional information about the integrity impacts
integrity__threatsCommentstringComment to add additional information about the integrity threats
privacyFramework__consentstringField to describe the measures to ensure that the consent of the data subjects has been obtained and how the given consent can be revoked Mandatory if DPIA is saved as activated and the lawfulness "consent_person_concerned" selected
additionalInformationFilesstring[]Additionalinformationfiles
integrity__baselineCommentstringComment to add additional information about the baseline risk of the integrity
integrity__implementedTomsstring[]List of TOMs that are implemented to prevent integrity risk. At least one element is necessary DPIA is saved as activated
privacyFramework__accuracystringField to explain if the data processed is accurate, high quality and up-to-date Mandatory if DPIA is saved as activated
integrity__baselineSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowprivacyFramework__retentionbooleanIs the retention period lawful and clearly defined? Mandatory if DPIA is saved as activated
availability__impactsCommentstringComment to add additional information about the impact
availability__threatsCommentstringComment to add additional information about the threat
confidentiality__plannedTomsstring[]List of TOMs that are planned to be implemented to prevent confidentiality risk. At least one element is necessary DPIA is saved as activated
confidentiality__riskSourcesobject[]List of risk sources that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
availability__baselineCommentstringComment to add additional information about the baseline risk of the availablity
availability__implementedTomsstring[]List of implemented TOMs that applies to the availability risk. At least one element is necessary DPIA is saved as activated
integrity__baselineLikelihoodstringenumBaselinelikelihood
likelylimitedmaximumnegligibleunlikelyintegrity__plannedTomsCommentstringComment to add additional information about planned TOMs to prevent integrity risk
integrity__riskSourcesCommentstringComment to add additional information about the integrity risk sources
availability__baselineSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowintegrity__residualRiskCommentstringComment to add additional information about the residual risk of the integrity
privacyFramework__transparencystringField to describe what kind of notice information is given to data subjects about this processing, and how is it provided to the data subjects? Mandatory if DPIA is saved as activated
confidentiality__impactsCommentstringComment to add additional information about the confidentiality risk impacts
confidentiality__threatsCommentstringComment to add additional information about the confidentiality risk threats
integrity__residualRiskSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowavailability__baselineLikelihoodstringenumBaselinelikelihood
likelylimitedmaximumnegligibleunlikelyavailability__plannedTomsCommentstringComment to add additional information about the planned TOMs
availability__riskSourcesCommentstringComment to add additional information about the availability risk sources
confidentiality__baselineCommentstringComment to add additional information about the baseline risk of the confidentiality
confidentiality__implementedTomsstring[]List of TOMs that are implemented to prevent confidentiality risk. At least one element is necessary DPIA is saved as activated
availability__residualRiskCommentstringComment to add additional information about the residual risk of the availability
confidentiality__baselineSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowintegrity__implementedTomsCommentstringComment to add additional information about implemented TOMs to prevent integrity risk
integrity__residualRiskLikelihoodstringenumResidualrisklikelihood
likelylimitedmaximumnegligibleunlikelyavailability__residualRiskSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowprivacyFramework__dataMinimisationstringField to explain if the data collected adequate, relevant, and limited to what is necessary concerning the purposes for which it is processed Mandatory if DPIA is saved as activated
privacyFramework__retentionCommentstringField to add comment on the retention period
confidentiality__baselineLikelihoodstringenumBaselinelikelihood
likelylimitedmaximumnegligibleunlikelyconfidentiality__plannedTomsCommentstringComment to add additional information about planned TOMs to prevent confidentiality risk
confidentiality__riskSourcesCommentstringComment to add additional information about the confidentiality risk sources
privacyFramework__additionalCommentstringField to add more information related to the privacy framework of the DPIA
privacyFramework__purposeLimitationstringField to explain the clear, specific and legitimate purpose of conducting the processing activity. Mandatory if DPIA is saved as activated
availability__implementedTomsCommentstringComment to add additional information about the implemented TOMs
availability__residualRiskLikelihoodstringenumResidualrisklikelihood
likelylimitedmaximumnegligibleunlikelyconfidentiality__residualRiskCommentstringComment to add additional information about the residual risk of the confidentiality
confidentiality__residualRiskSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowprivacyFramework__dataRightsExercisedstringField to describe how do data subjects exercise their data subject rights? Mandatory if DPIA is saved as activated
confidentiality__implementedTomsCommentstringComment to add additional information about implemented TOMs to prevent confidentiality risk
confidentiality__residualRiskLikelihoodstringenumResidualrisklikelihood
likelylimitedmaximumnegligibleunlikely
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create employee with json payloadBORNEO_CREATE_EMPLOYEE_WITH_JSON_PAYLOADAcciónCreates 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.
BORNEO_CREATE_EMPLOYEE_WITH_JSON_PAYLOADAcciónCreates 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.
Parámetros de entrada
nifstringThe NIF of the employee
namestringObligatorioThe name of the employee
emailstringthe email of the employee
endDatestringDate when the employee end to work in your company
managerstringemployeeId of the employee who is manager of the employee
surnamestringObligatorioThe surname of the employee
positionstringThe position of the employee in the company.
createdBystringObligatorioCreatedby
startDatestringDate when the employee began to work in your company
departmentstringthe department of the employee
referenceIdstringInternal identifier to synchronize with external APIS
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create headquarter entryBORNEO_CREATE_HEADQUARTER_ENTRYAcciónCreates 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.
BORNEO_CREATE_HEADQUARTER_ENTRYAcciónCreates 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.
Parámetros de entrada
citystringObligatorioThe locality of the headquarter
namestringObligatorioThe name of the headquarter
tomIdsstring[]Tomids
addressstringObligatorioThe address of the headquarter
countrystringObligatorio2 letter code that identifies a country.
zipcodestringThe zipcode of the headquarter
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create legal document entryBORNEO_CREATE_LEGAL_DOCUMENT_ENTRYAcciónCreates 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.
BORNEO_CREATE_LEGAL_DOCUMENT_ENTRYAcciónCreates 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.
Parámetros de entrada
namestringObligatorioName
typestringenumType
DATA_PROCESSINGPRIVACY_POLICYregionstringObligatorioRegion
sourcestringSource
documentLinkstringObligatorioDocumentlink
isDiscoverInfotypebooleanObligatorioIsdiscoverinfotype
fromDiscoveredDocumentIdstringFromdiscovereddocumentid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create new assetBORNEO_CREATE_NEW_ASSETAcciónCreates 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.
BORNEO_CREATE_NEW_ASSETAcciónCreates 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.
Parámetros de entrada
namestringObligatorioName of the asset to create
typestringObligatorioenumIndicates the type of the asset. An asset can be one of the several options.
applicationscloudServicescommunicationsdataInformationexternalStoragefilingRoomfurniturehardwarehostingotherpaperDocumentationprinter+3tomIdsstring[]Tomids
createdAtintegerCreatedat
locationIdstringLocationid
locationTypestringenumLocationtype
externalofficeremote
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create new infotype categoryBORNEO_CREATE_NEW_INFOTYPE_CATEGORYAcciónCreates 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.
BORNEO_CREATE_NEW_INFOTYPE_CATEGORYAcciónCreates 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.
Parámetros de entrada
infotypesstring[]ObligatorioThe list of infotypes that belong to this category.
descriptionstringDescription of the infotype category.
categoryLabelstringObligatorioThe name of the infotype category.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create processing activityBORNEO_CREATE_PROCESSING_ACTIVITYAcciónCreates 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.
BORNEO_CREATE_PROCESSING_ACTIVITYAcciónCreates 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.
Parámetros de entrada
namestringObligatorioName of the processing activity
ownerstringOwner
activebooleanObligatorioFlag to create the processing activity as activated or draft
assetsstring[]List assets ids related to the processing activity.
modelIdstringModelid
purposestringPurpose
languagestringenumLanguage
ardeeneses-ECes-MXfrhiitjaptzhcreatedAtintegerCreatedat
dataTypesstring[]Datatypes
infotypesstring[]List of info types related with the processing activity.
updatedAtintegerUpdatedat
recipientsobject[]List of recipients related with the processing activity.
companyRolestring[]Companyrole
dataSourcesstring[]Datasources
departmentsstring[]List departments related with the processing activity.
lawfulBasisobject[]List of Lawfulness types affected by a processing activity
dataSubjectsstring[]List of Data Subjects affected by the processing activity
isDataStoredbooleanIndicates if you store the data.
translationsobjectTranslations
contactPersonstringContact person for the processing activity.
additionalInfostringText to add more information about the processing activity
infotypeVolumestringenumRanges of the processed infotype volume.
0-10001000-1000010000-100000100000+managementMethodsobject[]Managementmethods
infotypeCategoriesstring[]List of info types categories related with the processing activity.
showOnRopaDocumentbooleanShowonropadocument
additionalInfoFilesstring[]List of uploaded file ids.
processingFrequencystringenumData processing frequency.
is_systematicnot_systematicdataFlowRelationshipsobject[]Dataflowrelationships
retentionPeriod__unitstringenumUnit of time that is used for retention period
daymonthweekyearretentionPeriodCommentstringRetentionperiodcomment
retentionPeriod__valueintegerValue
areAccessRequestsManagedbooleanIndicates if the data subject access requests are managed.
processingFrequencyCommentstringProcessingfrequencycomment
processingActivitiesAsDataSourcesstring[]Processingactivitiesasdatasources
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create processing activity thresholdBORNEO_CREATE_PROCESSING_ACTIVITY_THRESHOLDAcciónCreates 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.
BORNEO_CREATE_PROCESSING_ACTIVITY_THRESHOLDAcciónCreates 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.
Parámetros de entrada
statusstringenumStatus of the threshold. Can be draft or activated.
activateddraftcommentstringAdditional information related to the Threshold
additionalCommentbooleanAdditionalcomment
processingActivityIdstringObligatorioIdentifier of the processing activity for which the threshold will be created
largeScaleObservationbooleanLargescaleobservation
sensitiveOrSpecialDatabooleanSensitiveorspecialdata
rightsRiskProcessingDatabooleanRightsriskprocessingdata
freedomRiskProcessingDatabooleanFreedomriskprocessingdata
innovativeTechnologiesUsedbooleanInnovativetechnologiesused
processingPersonalDataRiskbooleanProcessingpersonaldatarisk
specialCategoryDataProcessedbooleanSpecialcategorydataprocessed
systematicPersonalAssessmentbooleanSystematicpersonalassessment
processingVulnerableDataSubjectbooleanProcessingvulnerabledatasubject
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create recipient with detailsBORNEO_CREATE_RECIPIENT_WITH_DETAILSAcciónCreates 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.
BORNEO_CREATE_RECIPIENT_WITH_DETAILSAcciónCreates 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.
Parámetros de entrada
dpastringThe url to the DPA of the recipient
namestringObligatorioName of the recipient. Has to be unique, 2 different recipients can"t have the same name.
rolestring[]Role
statestringenum2 letter code that identifies the state of the recipient. It only applies when the recipient country is US
AKALARAZCACOCTDCDEFLGAHI+39statusstringObligatorioenumThe status of the recipient. Can be archived or validated.
archivedvalidatedcountrystring2 letter code that identifies a country.
dpaFilesstring[]List of uploaded file ids.
createdAtintegerCreatedat
dpaStatusstringenumThe status of the DPA of the recipient. Attached if the DPA is provided. Not required when it"s not necessary to provide the information. Requested when we ask for the DPA and we are waiting for it.
attachednotRequiredrequestedupdatedAtintegerUpdatedat
categoriesstring[]list of recipient category
businessNamestringBusiness name of the recipient
recipientStatestringenumRecipientstate
activeassessmentsubProcessorIdsstring[]Subprocessorids
recipientModelIdstringIdentifier of the Recipient Model in case that the Recipient is created bases in a Recipient Model
dataStorageLocationstring[]ObligatorioList of countries where the data related to this recipient are stored
recipientWarrantiesstring[]ObligatorioList of lawful basis types that applies to the recipient.
fromDiscoveredRecipientIdstringFromdiscoveredrecipientid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Create threshold for processing activityBORNEO_CREATE_THRESHOLD_FOR_PROCESSING_ACTIVITYAcciónCreates 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.
BORNEO_CREATE_THRESHOLD_FOR_PROCESSING_ACTIVITYAcciónCreates 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.
Parámetros de entrada
statusstringenumStatus of the threshold. Can be draft or activated.
activateddraftcommentstringAdditional information related to the Threshold
blacklistbooleanIndicates if the data processing is included in a black list
createdAtintegerCreatedat
updatedAtintegerUpdatedat
translationsobjectTranslations
processingActivityIdstringObligatorioIdentifier of the processing activity for which the threshold will be created
classifyingDataSubjectbooleanIndicates if this data processing is assessing or classifying data subjects
automatedDecisionMakingbooleanIndicates if there is automated decision-making with legal effect, or similarly significant effect involved
largeScaleDataProcessingbooleanIndicates if is a large scale data processing
innovativeTechnologiesUsedbooleanIndicates if there are innovative technologies used
matchingMergingRecordsInvolvedbooleanIndicates if there is matching or merging of the records involved
processingVulnerableDataSubjectbooleanIndicates if there is processing of data of vulnerable data subjects
systematicMonitoringDataSubjectbooleanIndicates if there is systematic monitoring of data subjects involved
largeScaleProcessingSensitiveDatabooleanIndicates if the data processing is large scale processing of sensitive data.
monitoringPubliclyAccessibleAreasbooleanIndicates if the data processing is systematic and large scale monitoring of publicly accessible areas involved.
processingConfidentialSensitiveDatabooleanIndicates if there is processing of confidential or sensitive data
preventDataSubjectsExercisingTheirRightsbooleanIndicates if the data processing prevents the data subjects from exercising their rights, using a service or performing a contract
extensiveAutomatedEvaluationCharacteristicsbooleanIndicates if the data processing involve any systematic, extensive and automated evaluation of personal characteristics with effect for the data subjects.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete asset by idBORNEO_DELETE_ASSET_BY_IDAcciónThe 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.
BORNEO_DELETE_ASSET_BY_IDAcciónThe 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.
Parámetros de entrada
assetIdstringObligatorioIdentifier of the asset
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete category by labelBORNEO_DELETE_CATEGORY_BY_LABELAcciónDeletes 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.
BORNEO_DELETE_CATEGORY_BY_LABELAcciónDeletes 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.
Parámetros de entrada
categoryLabelstringObligatorioThe name of the infotype category.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete dashboard report by idBORNEO_DELETE_DASHBOARD_REPORT_BY_IDAcciónDeletes 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.
BORNEO_DELETE_DASHBOARD_REPORT_BY_IDAcciónDeletes 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.
Parámetros de entrada
dashboardReportIdstringObligatorioDashboardreportid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete department by idBORNEO_DELETE_DEPARTMENT_BY_IDAcciónDeletes 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.
BORNEO_DELETE_DEPARTMENT_BY_IDAcciónDeletes 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.
Parámetros de entrada
departmentIdstringObligatorioIdentifier of the department.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete domain by idBORNEO_DELETE_DOMAIN_BY_IDAcciónDeletes 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.
BORNEO_DELETE_DOMAIN_BY_IDAcciónDeletes 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.
Parámetros de entrada
domainIdstringObligatorioIdentifier of the domain.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete dpia by idBORNEO_DELETE_DPIA_BY_IDAcciónDeletes 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.
BORNEO_DELETE_DPIA_BY_IDAcciónDeletes 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.
Parámetros de entrada
dpiaIdstringObligatorioIdentifier of the DPIA
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete employee by idBORNEO_DELETE_EMPLOYEE_BY_IDAcciónDeletes 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.
BORNEO_DELETE_EMPLOYEE_BY_IDAcciónDeletes 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.
Parámetros de entrada
employeeIdstringObligatorioIdentifier of the employee
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete headquarters by idBORNEO_DELETE_HEADQUARTERS_BY_IDAcciónDeletes 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.
BORNEO_DELETE_HEADQUARTERS_BY_IDAcciónDeletes 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.
Parámetros de entrada
headquarterIdstringObligatorioThe identifier of the headquarter
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete legal document by idBORNEO_DELETE_LEGAL_DOCUMENT_BY_IDAcciónDeletes 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.
BORNEO_DELETE_LEGAL_DOCUMENT_BY_IDAcciónDeletes 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.
Parámetros de entrada
documentIdstringObligatorioDocumentid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete lopdp threshold by idBORNEO_DELETE_LOPDP_THRESHOLD_BY_IDAcciónThis 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.
BORNEO_DELETE_LOPDP_THRESHOLD_BY_IDAcciónThis 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.
Parámetros de entrada
lopdpThresholdIdstringObligatorioIdentifier of the Threshold
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete processing activity by idBORNEO_DELETE_PROCESSING_ACTIVITY_BY_IDAcciónDeletes 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.
BORNEO_DELETE_PROCESSING_ACTIVITY_BY_IDAcciónDeletes 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.
Parámetros de entrada
processingActivityIdstringObligatorioIdentifier of the Processing Activity
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete recipient by idBORNEO_DELETE_RECIPIENT_BY_IDAcciónDeletes 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.
BORNEO_DELETE_RECIPIENT_BY_IDAcciónDeletes 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.
Parámetros de entrada
recipientIdstringObligatorioIdentifier of the Recipient
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete tag from resourceBORNEO_DELETE_TAG_FROM_RESOURCEAcciónThe 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.
BORNEO_DELETE_TAG_FROM_RESOURCEAcciónThe 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.
Parámetros de entrada
tagKeystringObligatorioTagkey
tagValuestringTagvalue
tagResourcesobjectObligatorioTagresources
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Delete threshold by idBORNEO_DELETE_THRESHOLD_BY_IDAcciónDeletes 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.
BORNEO_DELETE_THRESHOLD_BY_IDAcciónDeletes 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.
Parámetros de entrada
thresholdIdstringObligatorioIdentifier of the Threshold
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Disable dashboard user by usernameBORNEO_DISABLE_DASHBOARD_USER_BY_USERNAMEAcciónDisables 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.
BORNEO_DISABLE_DASHBOARD_USER_BY_USERNAMEAcciónDisables 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.
Parámetros de entrada
usernamestringObligatorioUsername
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Download dashboard reportBORNEO_DOWNLOAD_DASHBOARD_REPORTAcciónThe 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.
BORNEO_DOWNLOAD_DASHBOARD_REPORTAcciónThe 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.
Parámetros de entrada
reportTypestringObligatorioenumReporttype
DATA_DISCOVERY_DASHBOARDPRIVACY_OPS_DASHBOARDPRIVACY_OPS_DATA_FLOW
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Download dashboard report editionBORNEO_DOWNLOAD_DASHBOARD_REPORT_EDITIONAcciónDownloads 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.
BORNEO_DOWNLOAD_DASHBOARD_REPORT_EDITIONAcciónDownloads 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.
Parámetros de entrada
reportEditionIdstringObligatorioReporteditionid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Enable dashboard userBORNEO_ENABLE_DASHBOARD_USERAcciónEnables 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.
BORNEO_ENABLE_DASHBOARD_USERAcciónEnables 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.
Parámetros de entrada
usernamestringObligatorioUsername
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Evaluate data breach impactBORNEO_EVALUATE_DATA_BREACH_IMPACTAcciónThis 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.
BORNEO_EVALUATE_DATA_BREACH_IMPACTAcciónThis 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.
Parámetros de entrada
rolestringenumRole of the recipient.
controllerindependent_controllerjoint_controllerprocessorsub_processorevaluationstringEvaluation
saveAsDraftbooleanObligatorioSaveasdraft
dataBreachIdstringObligatorioIdentifier of the DataBreach
reportLanguagestringenumReportlanguage
ardeeneses-ECes-MXfrhiitjaptzhcompaniesAffectedstringCompaniesaffected
processorNotifiedbooleanProcessornotified
dataBreachLocationstringenumDatabreachlocation
ourOrganisationthirdPartyProcessorprocessorsInvolvedstringProcessorsinvolved
authoritiesNotifiedbooleanAuthoritiesnotified
dataBreachControllerstringDatabreachcontroller
dataSubjectsNotifiedbooleanDatasubjectsnotified
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export filtered leaf resourcesBORNEO_EXPORT_FILTERED_LEAF_RESOURCESAcciónThe 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.
BORNEO_EXPORT_FILTERED_LEAF_RESOURCESAcciónThe 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.
Parámetros de entrada
detailedbooleanSet to `true` if the results exported to have detailed column level information of the detected infotypes.
sourceTypestringFilter resource based on the source type. eg: "MYSQL", "RDS_MYSQL", "S3", "PRESTO", etc.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__regionstring[]One or more cloud provider regions.
filter__schemastring[]List tables from a specific schema. Supported for the following resource types: Presto.
filter__searchstringFree-text search on the resource name.
filter__statusstring[]Filter the resources based on list of status.
filter__accountstring[]One or more cloud provider account IDs.
filter__datasetstring[]List tables from a specific dataset. Supported for on the following resource types: BigQuery.
filter__driveIdstring[]List drives from a specific driveId. Supported for the following resource types: Gdrive.
filter__noOwnerbooleanInclude only resources that have not been assigned an owner.
filter__scannedbooleanInclude only resources that have been scanned.
filter__databasestring[]List tables from a specific database. Supported for the following resource types: (RDS) PostgreSQL, (RDS) MySQL, MongoDB.
filter__hasOwnerbooleanInclude only resources that have been assigned an owner.
filter__instancestring[]One or more resource IDs of the instances to which the resources belong, i.e. the parent resource ID.
filter__parentIdstringFilter the resources which has the specified parent ID.
filter__driveTypestring[]List drives from a specific drive type. Supported for the following resource types: Gdrive.
filter__firstSeenobjectSet of conditions for comparing two timestamps.
filter__orgUnitIdstring[]List orgUnits from a specific orgUnitIds. Supported for the following resource types: Gdrive.
filter__spaceTypestring[]Filter conlfluences based on type
filter__categoriesstring[]Filter the resources matching with the list of categories.
filter__resourceIdstring[]Filter the resources with the specified resource IDs.
filter__spaceStatusstring[]Filter conlfluences based on status
filter__resourceTagsobject[]Filter the resources based on tags
filter__resourceTypestring[]Filter the resources which can be scanned by Borneo.
filter__severityScorestring[]Filter the resources based on the assigned risk severity score; "critical" = 4, "high" = 3, "medium" = 2, "low" = 1.
filter__classificationstring[]Filter the resources matching with the list of classifications.
filter__infoTypes__opsstringenumOps
ANDORfilter__infoTypes__infoTypesstring[]The list of infotypes to filter on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export insight page using scanidBORNEO_EXPORT_INSIGHT_PAGE_USING_SCAN_IDAcciónThe 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.
BORNEO_EXPORT_INSIGHT_PAGE_USING_SCAN_IDAcciónThe 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.
Parámetros de entrada
scanIdstringObligatorioThe unique scan ID.
detailedbooleanSet to `true` if the results exported to have detailed column level information of the detected infotypes with masked tokens if captured.
filter__pageIdstringUnique page ID. Only applicable to page-level results.
filter__scanIdstringUnique scan ID.
filter__searchstringFree-text search on the resource name.
filter__statusstring[]Status
filter__categoriesstring[]infotype categories
filter__userEmailsstring[]Useremails
filter__resourceIdsstring[]One or more resource IDs for which to retrieve results. Only applicable to page-level results.
filter__resourceTypestringResource type to filter results by.
filter__fileExtensionstring[]Fileextension
filter__infoTypes__opsstringenumOps
ANDORfilter__scanIterationIdstringUnique scan iteration ID to fetch results for a specific run of
filter__infotypeConfidencestring[]Infotypeconfidence
filter__infoTypes__infoTypesstring[]The list of infotypes to filter on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export inventory resource listBORNEO_EXPORT_INVENTORY_RESOURCE_LISTAcciónExports 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.
BORNEO_EXPORT_INVENTORY_RESOURCE_LISTAcciónExports 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.
Parámetros de entrada
selectstring[]A list of property names to return in the response. If not specified, all resource properties will be returned.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringOptional "nextToken" value from the last API response.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__hasPiibooleanInclude only resources that have a high likelihood of containing PII based on the resource metadata.
filter__regionstringThe region of the cloud account to which the resoure belongs.
filter__searchstringFree-text search on the resource name.
filter__noOwnerbooleanInclude only resources that have not been assigned an owner.
filter__regionsstring[]List of regions to which the resoure belongs to in that cloud account.
filter__hasOwnerbooleanInclude only resources that have been assigned an owner.
filter__parentIdstringThe parent Id of the resource. E.g. Borneo-specific GCP subscription ID for GCP resources
filter__accountIdstringThe account ID of the cloud account to which the resoure belongs. E.g. a 12-digit AWS account ID.
filter__dataRisksstring[]Filter the resources that has data risks.
filter__firstSeenobjectSet of conditions for comparing two timestamps.
filter__resourceIdsstring[]One or more resource IDs to return.
filter__resourceTagsobject[]Filter the resources based on tags
filter__resourceTypestringFilter the resources based on the resource type.
filter__severityScoreinteger[]Filter the resources based on the assigned risk severity score; "critical" = 4, "high" = 3, "medium" = 2, "low" = 1.
filter__classificationstring[]Filter the resources based on classification and are non-compliant. eg "PII_L1", "PII_L2", "PII_L3". Custom added classifications is also supported.
include__violationMetricsbooleanInclude violation count by severity for resource and child resources.
filter__hideBorneoResourcesbooleanWhether to hide resources that are part of the Borneo data plane.
filter__dataSourceCategoriesstring[]Filter the resources based on the data source category Current supported values: AWS_DATA_STORES, GCP_DATA_STORES, STANDALONE_DATA_STORES, CLOUD_APPLICATIONS, DISCOVERED_APPLICATIONS
filter__scannableResourceTypesbooleanFilter the resources that are scannable
include__frameworkExceptionsCountbooleanInclude framework exceptions count for the resource and its children
include__childResourceStats__scansbooleanInclude aggregate scan stats from child resources.
include__childResourceStats__dataSizebooleanInclude aggregate data size stats from child resources.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export processing activities listBORNEO_EXPORT_PROCESSING_ACTIVITIES_LISTAcciónThis 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.
BORNEO_EXPORT_PROCESSING_ACTIVITIES_LISTAcciónThis 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.
Parámetros de entrada
languagestringObligatorioenumLanguage
ardeeneses-ECes-MXfrhiitjaptzhexportTypesstring[]ObligatorioExporttypes
filter__ownersstring[]Owners
filter__searchstringSearch
filter__statusstring[]Status
filter__employeesstring[]Employees
filter__infotypesstring[]Infotypes
filter__recipientsstring[]Recipients
filter__departmentsstring[]Departments
filter__dataSubjectsstring[]Datasubjects
filter__processingActivityIdstringProcessingactivityid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Export recipients list with filterBORNEO_EXPORT_RECIPIENTS_LIST_WITH_FILTERAcciónThe 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.
BORNEO_EXPORT_RECIPIENTS_LIST_WITH_FILTERAcciónThe 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.
Parámetros de entrada
exportTypesstring[]ObligatorioExporttypes
filter__rolestring[]Role
filter__searchstringFree-form text search to apply to the Recipient name.
filter__statusstringenumThe status of the recipient. Can be archived or validated.
archivedvalidatedfilter__usedInobjectUsedin
filter__categoriesstring[]list of recipient category
filter__departmentsstring[]Departments
filter__recipientIdsstring[]Recipientids
filter__recipientStatestring[]Recipientstate
filter__discoverySourcestring[]Discoverysource
filter__subProcessorIdsstring[]Subprocessorids
filter__automationStatusstring[]Automationstatus
filter__recipientWarrantiesstring[]Recipientwarranties
filter__withNoProcessingActivitybooleanWithnoprocessingactivity
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch dashboard report by idBORNEO_FETCH_DASHBOARD_REPORT_BY_IDAcciónRetrieves 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.
BORNEO_FETCH_DASHBOARD_REPORT_BY_IDAcciónRetrieves 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.
Parámetros de entrada
dashboardReportIdstringObligatorioDashboardreportid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Fetch data breach evaluationBORNEO_FETCH_DATA_BREACH_EVALUATIONAcciónRetrieves 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.
BORNEO_FETCH_DATA_BREACH_EVALUATIONAcciónRetrieves 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.
Parámetros de entrada
dataBreachIdstringObligatorioIdentifier of the DataBreach
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Filter and list inspection resultsBORNEO_FILTER_AND_LIST_INSPECTION_RESULTSAcciónThe 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.
BORNEO_FILTER_AND_LIST_INSPECTION_RESULTSAcciónThe 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.
Parámetros de entrada
typestringObligatorioenumType of inspection result, i.e. scan-level or page-level results.
pagescanpageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__pageIdstringUnique page ID. Only applicable to page-level results.
filter__scanIdstringUnique scan ID.
filter__searchstringFree-text search on the resource name.
filter__statusstring[]Status
filter__categoriesstring[]infotype categories
filter__userEmailsstring[]Useremails
filter__resourceIdsstring[]One or more resource IDs for which to retrieve results. Only applicable to page-level results.
filter__resourceTypestringResource type to filter results by.
filter__fileExtensionstring[]Fileextension
filter__infoTypes__opsstringenumOps
ANDORfilter__scanIterationIdstringUnique scan iteration ID to fetch results for a specific run of
filter__infotypeConfidencestring[]Infotypeconfidence
filter__infoTypes__infoTypesstring[]The list of infotypes to filter on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Filter and sort assets listBORNEO_FILTER_AND_SORT_ASSETS_LISTAcciónThe 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.
BORNEO_FILTER_AND_SORT_ASSETS_LISTAcciónThe 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.
Parámetros de entrada
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
maxResultsintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
sort__orderstringenumOrder
ASCDESCfilter__typestring[]Type
sort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the asset name.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Filter employee listBORNEO_FILTER_EMPLOYEE_LISTAcciónThe 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.
BORNEO_FILTER_EMPLOYEE_LISTAcciónThe 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Filter recipients listBORNEO_FILTER_RECIPIENTS_LISTAcciónThe 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.
BORNEO_FILTER_RECIPIENTS_LISTAcciónThe 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get category by labelBORNEO_GET_CATEGORY_BY_LABELAcciónRetrieves 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.
BORNEO_GET_CATEGORY_BY_LABELAcciónRetrieves 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.
Parámetros de entrada
categoryLabelstringObligatorioThe name of the infotype category.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get cloud account by idBORNEO_GET_CLOUD_ACCOUNT_BY_IDAcciónRetrieves 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.
BORNEO_GET_CLOUD_ACCOUNT_BY_IDAcciónRetrieves 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.
Parámetros de entrada
cloudAccountIdstringObligatorioThe cloud-provider specific account ID, e.g. a 12-digit AWS account ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get dashboard report edition by idBORNEO_GET_DASHBOARD_REPORT_EDITION_BY_IDAcciónRetrieves 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.
BORNEO_GET_DASHBOARD_REPORT_EDITION_BY_IDAcciónRetrieves 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.
Parámetros de entrada
reportEditionIdstringObligatorioReporteditionid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get department filter listBORNEO_GET_DEPARTMENT_FILTER_LISTAcciónThe 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.
BORNEO_GET_DEPARTMENT_FILTER_LISTAcciónThe 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get domain by idBORNEO_GET_DOMAIN_BY_IDAcciónRetrieves 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.
BORNEO_GET_DOMAIN_BY_IDAcciónRetrieves 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.
Parámetros de entrada
domainIdstringObligatorioIdentifier of the domain.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get headquarters by idBORNEO_GET_HEADQUARTERS_BY_IDAcciónRetrieves 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.
BORNEO_GET_HEADQUARTERS_BY_IDAcciónRetrieves 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.
Parámetros de entrada
headquarterIdstringObligatorioThe identifier of the headquarter
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get insight by type and idBORNEO_GET_INSIGHT_BY_TYPE_AND_IDAcciónRetrieves 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.
BORNEO_GET_INSIGHT_BY_TYPE_AND_IDAcciónRetrieves 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.
Parámetros de entrada
idstringObligatorioThe unique ID of the inspection result to fetch.
typestringObligatorioenumThe type of inspection result to fetch.
pagescan
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get resource inventory by idBORNEO_GET_RESOURCE_INVENTORY_BY_IDAcciónRetrieves 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.
BORNEO_GET_RESOURCE_INVENTORY_BY_IDAcciónRetrieves 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.
Parámetros de entrada
resourceIdstringObligatorioThe unique resource ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get scan by scanidBORNEO_GET_SCAN_BY_SCAN_IDAcciónRetrieves 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.
BORNEO_GET_SCAN_BY_SCAN_IDAcciónRetrieves 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.
Parámetros de entrada
scanIdstringObligatorioScanid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get threshold by idBORNEO_GET_THRESHOLD_BY_IDAcciónRetrieves 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.
BORNEO_GET_THRESHOLD_BY_IDAcciónRetrieves 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.
Parámetros de entrada
thresholdIdstringObligatorioIdentifier of the Threshold
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get user profile by idBORNEO_GET_USER_PROFILE_BY_IDAcciónRetrieves 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.
BORNEO_GET_USER_PROFILE_BY_IDAcciónRetrieves 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.
Parámetros de entrada
userIdstringObligatorioUserid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List dashboard report editionsBORNEO_LIST_DASHBOARD_REPORT_EDITIONSAcciónLists 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.
BORNEO_LIST_DASHBOARD_REPORT_EDITIONSAcciónLists 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringNexttoken
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
dashboardReportIdstringObligatorioThe `nextToken` from the last page of results to retrieve the next page of results.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List dashboard reports with filtersBORNEO_LIST_DASHBOARD_REPORTS_WITH_FILTERSAcciónRetrieves 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.
BORNEO_LIST_DASHBOARD_REPORTS_WITH_FILTERSAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCfilter__typestring[]Type
sort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the scan name.
filter__frequencystring[]Frequency
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List dashboard users with filtersBORNEO_LIST_DASHBOARD_USERS_WITH_FILTERSAcciónLists 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.
BORNEO_LIST_DASHBOARD_USERS_WITH_FILTERSAcciónLists 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.
Parámetros de entrada
filter__rolesstring[]Roles
filter__tenantIdstringTenantid
filter__departmentsstring[]Departments
filter__organisationIdintegerOrganisationid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List data breaches with filtersBORNEO_LIST_DATA_BREACHES_WITH_FILTERSAcciónThe 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.
BORNEO_LIST_DATA_BREACHES_WITH_FILTERSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__ownerstring[]Owner
filter__searchstringFree-form text search to apply to data breaches short description.
filter__statusstring[]Status
filter__authoritiesNotifiedboolean[]Authoritiesnotified
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List data breach filtersBORNEO_LIST_DATA_BREACH_FILTERSAcciónRetrieves 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.
BORNEO_LIST_DATA_BREACH_FILTERSAcciónRetrieves 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.
Parámetros de entrada
filterTypestringObligatorioenumFiltertype
ownerstatus
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List departments with sort and paginationBORNEO_LIST_DEPARTMENTS_WITH_SORT_AND_PAGINATIONAcciónThe 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.
BORNEO_LIST_DEPARTMENTS_WITH_SORT_AND_PAGINATIONAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the department name.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List discovered documentBORNEO_LIST_DISCOVERED_DOCUMENTAcciónRetrieves 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.
BORNEO_LIST_DISCOVERED_DOCUMENTAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the scan name.
filter__statusstringenumStatus
ADDEDDELETEDDOMAIN_DELETEDIGNOREDNEW
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List discovered infotypesBORNEO_LIST_DISCOVERED_INFOTYPESAcciónThe 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.
BORNEO_LIST_DISCOVERED_INFOTYPESAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the scan name.
filter__statusstringenumStatus
APPROVEDAPPROVED_AUTOMATICALLYDELETEDIGNOREDNEWNOT_PRESENTREQUESTED
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List discovered recipientsBORNEO_LIST_DISCOVERED_RECIPIENTSAcciónLists 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.
BORNEO_LIST_DISCOVERED_RECIPIENTSAcciónLists 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the DiscoveredRecipient name.
filter__statusstringenumStatus of the discovered recipient. Can be new or ignored if it"s marked as ignored.
ignorednewfilter__discoverySourcestring[]Discoverysource
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List domains with pagination and sortingBORNEO_LIST_DOMAINS_WITH_PAGINATION_AND_SORTINGAcciónRetrieves 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.
BORNEO_LIST_DOMAINS_WITH_PAGINATION_AND_SORTINGAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List employees with filtersBORNEO_LIST_EMPLOYEES_WITH_FILTERSAcciónRetrieves 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.
BORNEO_LIST_EMPLOYEES_WITH_FILTERSAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the employee name.
filter__departmentstring[]Department
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List error details from filtered scan iterationsBORNEO_LIST_ERROR_DETAILS_FROM_FILTERED_SCAN_ITERATIONSAcciónThe 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.
BORNEO_LIST_ERROR_DETAILS_FROM_FILTERED_SCAN_ITERATIONSAcciónThe 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.
Parámetros de entrada
selectstring[]List of column names to include in the response.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__scanIdstringScanid
filter__accountIdstringAccountid
filter__resourceIdstringResourceid
filter__scanExecutionIdstringScanexecutionid
filter__scanIterationIdstringScaniterationid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List events with filtersBORNEO_LIST_EVENTS_WITH_FILTERSAcciónLists 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.
BORNEO_LIST_EVENTS_WITH_FILTERSAcciónLists 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.
Parámetros de entrada
selectstring[]Select
pageSizeintegerPagesize
nextTokenstringNexttoken
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__scanIdstring[]Scanid
filter__searchstringSearch
filter__userIdstring[]Userid
filter__eventIdstring[]Eventid
filter__issueIdstring[]Issueid
filter__issueTypestring[]Issuetype
filter__resourceIdstring[]Resourceid
filter__newInfotypeFoundbooleanNewinfotypefound
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List filtered sorted categoriesBORNEO_LIST_FILTERED_SORTED_CATEGORIESAcciónThe 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.
BORNEO_LIST_FILTERED_SORTED_CATEGORIESAcciónThe 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.
Parámetros de entrada
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__categoriesstring[]Categories
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List filter options for recipientsBORNEO_LIST_FILTER_OPTIONS_FOR_RECIPIENTSAcciónLists 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.
BORNEO_LIST_FILTER_OPTIONS_FOR_RECIPIENTSAcciónLists 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.
Parámetros de entrada
filterTypestringObligatorioenumFiltertype
categoriesrole
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List headquarters with sortingBORNEO_LIST_HEADQUARTERS_WITH_SORTINGAcciónThe 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.
BORNEO_LIST_HEADQUARTERS_WITH_SORTINGAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List insight filtersBORNEO_LIST_INSIGHT_FILTERSAcciónThe 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.
BORNEO_LIST_INSIGHT_FILTERSAcciónThe 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.
Parámetros de entrada
scanIdstringScanid
filterTypestringenumFiltertype
fileExtension
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List inventory resources with filtersBORNEO_LIST_INVENTORY_RESOURCES_WITH_FILTERSAcciónRetrieves 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.
BORNEO_LIST_INVENTORY_RESOURCES_WITH_FILTERSAcciónRetrieves 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.
Parámetros de entrada
selectstring[]A list of property names to return in the response. If not specified, all resource properties will be returned.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringOptional "nextToken" value from the last API response.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__hasPiibooleanInclude only resources that have a high likelihood of containing PII based on the resource metadata.
filter__regionstringThe region of the cloud account to which the resoure belongs.
filter__searchstringFree-text search on the resource name.
filter__noOwnerbooleanInclude only resources that have not been assigned an owner.
filter__regionsstring[]List of regions to which the resoure belongs to in that cloud account.
filter__hasOwnerbooleanInclude only resources that have been assigned an owner.
filter__parentIdstringThe parent Id of the resource. E.g. Borneo-specific GCP subscription ID for GCP resources
filter__accountIdstringThe account ID of the cloud account to which the resoure belongs. E.g. a 12-digit AWS account ID.
filter__dataRisksstring[]Filter the resources that has data risks.
filter__firstSeenobjectSet of conditions for comparing two timestamps.
filter__resourceIdsstring[]One or more resource IDs to return.
filter__resourceTagsobject[]Filter the resources based on tags
filter__resourceTypestringFilter the resources based on the resource type.
filter__severityScoreinteger[]Filter the resources based on the assigned risk severity score; "critical" = 4, "high" = 3, "medium" = 2, "low" = 1.
filter__classificationstring[]Filter the resources based on classification and are non-compliant. eg "PII_L1", "PII_L2", "PII_L3". Custom added classifications is also supported.
include__violationMetricsbooleanInclude violation count by severity for resource and child resources.
filter__hideBorneoResourcesbooleanWhether to hide resources that are part of the Borneo data plane.
filter__dataSourceCategoriesstring[]Filter the resources based on the data source category Current supported values: AWS_DATA_STORES, GCP_DATA_STORES, STANDALONE_DATA_STORES, CLOUD_APPLICATIONS, DISCOVERED_APPLICATIONS
filter__scannableResourceTypesbooleanFilter the resources that are scannable
include__frameworkExceptionsCountbooleanInclude framework exceptions count for the resource and its children
include__childResourceStats__scansbooleanInclude aggregate scan stats from child resources.
include__childResourceStats__dataSizebooleanInclude aggregate data size stats from child resources.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List issues with filtersBORNEO_LIST_ISSUES_WITH_FILTERSAcciónThe 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.
BORNEO_LIST_ISSUES_WITH_FILTERSAcciónThe 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.
Parámetros de entrada
selectstring[]List of column names to include in the response.
includeobjectThe set of related resources that should be included in the response using a join-query.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-text search on the resource name.
filter__statesstring[]List of isssue states to filter by.
filter__resourcesstring[]List of resource IDs to filter by.
filter__severitiesstring[]List of issue severities to filter by.
filter__resourceTypesstring[]List of resource types to filter by.
filter__failedControlsstring[]List of failed controls to filter by.
filter__cloudAccountIdsstring[]List of cloud provider account IDs to filter by.
filter__cloudAccountTypesstring[]List of cloud provider account types to filter by.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List leaf resources with filtersBORNEO_LIST_LEAF_RESOURCES_WITH_FILTERSAcciónThe 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.
BORNEO_LIST_LEAF_RESOURCES_WITH_FILTERSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringOptional "nextToken" value from the last API response.
sourceTypestringFilter resource based on the resource type.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__regionstring[]One or more cloud provider regions.
filter__schemastring[]List tables from a specific schema. Supported for the following resource types: Presto.
filter__searchstringFree-text search on the resource name.
filter__statusstring[]Filter the resources based on list of status.
filter__accountstring[]One or more cloud provider account IDs.
filter__datasetstring[]List tables from a specific dataset. Supported for on the following resource types: BigQuery.
filter__driveIdstring[]List drives from a specific driveId. Supported for the following resource types: Gdrive.
filter__noOwnerbooleanInclude only resources that have not been assigned an owner.
filter__scannedbooleanInclude only resources that have been scanned.
filter__databasestring[]List tables from a specific database. Supported for the following resource types: (RDS) PostgreSQL, (RDS) MySQL, MongoDB.
filter__hasOwnerbooleanInclude only resources that have been assigned an owner.
filter__instancestring[]One or more resource IDs of the instances to which the resources belong, i.e. the parent resource ID.
filter__parentIdstringFilter the resources which has the specified parent ID.
filter__driveTypestring[]List drives from a specific drive type. Supported for the following resource types: Gdrive.
filter__firstSeenobjectSet of conditions for comparing two timestamps.
filter__orgUnitIdstring[]List orgUnits from a specific orgUnitIds. Supported for the following resource types: Gdrive.
filter__spaceTypestring[]Filter conlfluences based on type
filter__categoriesstring[]Filter the resources matching with the list of categories.
filter__resourceIdstring[]Filter the resources with the specified resource IDs.
filter__spaceStatusstring[]Filter conlfluences based on status
filter__resourceTagsobject[]Filter the resources based on tags
filter__resourceTypestring[]Filter the resources which can be scanned by Borneo.
filter__severityScorestring[]Filter the resources based on the assigned risk severity score; "critical" = 4, "high" = 3, "medium" = 2, "low" = 1.
filter__classificationstring[]Filter the resources matching with the list of classifications.
filter__infoTypes__opsstringenumOps
ANDORinclude__violationSummarybooleanViolationsummary
filter__infoTypes__infoTypesstring[]The list of infotypes to filter on.
include__frameworkExceptionsCountbooleanFrameworkexceptionscount
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List legal documents with paginationBORNEO_LIST_LEGAL_DOCUMENTS_WITH_PAGINATIONAcciónRetrieves 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.
BORNEO_LIST_LEGAL_DOCUMENTS_WITH_PAGINATIONAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the scan name.
filter__statusstringenumStatus
CREATEDDELETEDSCANNING
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List or filter recipientsBORNEO_LIST_OR_FILTER_RECIPIENTSAcciónThe 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.
BORNEO_LIST_OR_FILTER_RECIPIENTSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCfilter__rolestring[]Role
sort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the Recipient name.
filter__statusstringenumThe status of the recipient. Can be archived or validated.
archivedvalidatedfilter__usedInobjectUsedin
filter__categoriesstring[]list of recipient category
filter__departmentsstring[]Departments
filter__recipientIdsstring[]Recipientids
filter__recipientStatestring[]Recipientstate
filter__discoverySourcestring[]Discoverysource
filter__subProcessorIdsstring[]Subprocessorids
filter__automationStatusstring[]Automationstatus
filter__recipientWarrantiesstring[]Recipientwarranties
filter__withNoProcessingActivitybooleanWithnoprocessingactivity
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List processing activitiesBORNEO_LIST_PROCESSING_ACTIVITIESAcciónListprocessingactivities 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.
BORNEO_LIST_PROCESSING_ACTIVITIESAcciónListprocessingactivities 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__assetsstring[]Assets
filter__ownersstring[]Owners
filter__searchstringFree-form text search to apply to processing activity name.
filter__statusstring[]Status
filter__dataTypesstring[]Datatypes
filter__employeesstring[]Employees
filter__infotypesstring[]Infotypes
filter__languagesstring[]Languages
filter__recipientsstring[]Recipients
filter__dataSourcesstring[]Datasources
filter__departmentsstring[]Departments
filter__companyRolesstring[]Companyroles
filter__dataSubjectsstring[]Datasubjects
filter__paAsDataSourcestring[]Paasdatasource
filter__infotypeCategoriesstring[]Infotypecategories
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List processing activities filtersBORNEO_LIST_PROCESSING_ACTIVITIES_FILTERSAcciónThis 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.
BORNEO_LIST_PROCESSING_ACTIVITIES_FILTERSAcciónThis 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.
Parámetros de entrada
filterTypestringObligatorioenumFiltertype
assetcompanyRoledataSubjectdepartmentemployeeownerrecipientstatus
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List scan execution resultsBORNEO_LIST_SCAN_EXECUTION_RESULTSAcciónThe 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.
BORNEO_LIST_SCAN_EXECUTION_RESULTSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringNexttoken
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__scanIdstringUnique scan ID.
filter__searchstringFree-text search on the resource name.
filter__statusesstring[]Statuses
filter__resourceIdsstring[]One or more resource IDs for which to retrieve results. Only applicable to page-level results.
filter__infoTypes__opsstringenumOps
ANDORfilter__scanIterationIdstringScaniterationid
filter__infotypeConfidencestring[]One or more confidence matches for the scan.
filter__infoTypes__infoTypesstring[]The list of infotypes to filter on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List scan iterations with filterBORNEO_LIST_SCAN_ITERATIONS_WITH_FILTERAcciónThe 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.
BORNEO_LIST_SCAN_ITERATIONS_WITH_FILTERAcciónThe 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.
Parámetros de entrada
selectstring[]List of column names to include in the response.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__scanIdstringScanid
filter__resourceIdstringResourceid
filter__scanIterationIdstringScaniterationid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List scans with filtersBORNEO_LIST_SCANS_WITH_FILTERSAcciónThe 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.
BORNEO_LIST_SCANS_WITH_FILTERSAcciónThe 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.
Parámetros de entrada
selectstring[]List of column names to include in the response.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringFree-form text search to apply to the scan name.
filter__statusstring[]One or more scan statuses (e.g. `inprogress`, `completed`, etc.) to filter results by.
filter__scanTypestring[]One or more scan types (i.e. "full" or "sample") to filter results by.
getNextExecutionbooleanIF true, nextExecution will be populated for postponed and repeated scans
filter__accountIdstring[]One or more AWS accounts to filter results by.
filter__resourcesstring[]One or more resource IDs to filter results by.
filter__connectorIdstring[]One or more connector IDs to filter results by.
filter__dataPlaneIdstring[]One or more data plane IDs to filter results by.
filter__gcpProjectIdstring[]One or more GCP projects to filter results by.
filter__resourceTypestring[]One or moreresource types to filter results by.
filter__dataPlaneNamestring[]One or more data plane names to filter results by.
filter__infoTypes__opsstringenumOps
ANDORfilter__infoTypes__infoTypesstring[]The list of infotypes to filter on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List toms with filter and pagination optionsBORNEO_LIST_TOMS_WITH_FILTER_AND_PAGINATION_OPTIONSAcciónThe 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.
BORNEO_LIST_TOMS_WITH_FILTER_AND_PAGINATION_OPTIONSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
sort__orderstringenumOrder
ASCDESCfilter__liststring[]List
filter__typestring[]Type
sort__columnstringThe column name to sort on.
filter__tomIdstring[]Tomid
filter__searchstringFree-form text search to apply to the toms name.
filter__statusstring[]Status
filter__categorystring[]Category
filter__objectCategorystring[]Objectcategory
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
List user profile with filters and sortingBORNEO_LIST_USER_PROFILE_WITH_FILTERS_AND_SORTINGAcciónThe 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.
BORNEO_LIST_USER_PROFILE_WITH_FILTERS_AND_SORTINGAcciónThe 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.
Parámetros de entrada
selectstring[]Select
pageSizeintegerPagesize
nextTokenstringNexttoken
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__searchstringSearch
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Mark scan false positives by idBORNEO_MARK_SCAN_FALSE_POSITIVES_BY_IDAcciónMarks 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.
BORNEO_MARK_SCAN_FALSE_POSITIVES_BY_IDAcciónMarks 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.
Parámetros de entrada
scanIdstringObligatorioThe unique scan ID.
reportsstring[]Reports
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Pause scan by idBORNEO_PAUSE_SCAN_BY_IDAcciónThe 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.
BORNEO_PAUSE_SCAN_BY_IDAcciónThe 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.
Parámetros de entrada
scanIdstringObligatorioThe unique scan ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Poll domain by idBORNEO_POLL_DOMAIN_BY_IDAcciónThis 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.
BORNEO_POLL_DOMAIN_BY_IDAcciónThis 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.
Parámetros de entrada
domainIdstringObligatorioIdentifier of the domain.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post accounts with filter and sort optionsBORNEO_POST_ACCOUNTS_WITH_FILTER_AND_SORT_OPTIONSAcciónThe 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.
BORNEO_POST_ACCOUNTS_WITH_FILTER_AND_SORT_OPTIONSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringOptional "nextToken" value from the last API response.
sort__orderstringenumOrder
ASCDESCfilter__typestringFilter accounts by account type.
sort__columnstringThe column name to sort on.
filter__searchstringSearch for accounts by name.
filter__statusstring[]Filter accounts by status.
filter__accountIdstring[]Filter accounts by the Borneo account ID.
filter__activeStatesbooleanFilters out accounts which are not in deleting or deleted states
filter__cloudAccountIdstring[]Filter accounts by the cloud-provider specific account ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post classification statsBORNEO_POST_CLASSIFICATION_STATSAcciónRetrieves 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.
BORNEO_POST_CLASSIFICATION_STATSAcciónRetrieves 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.
Parámetros de entrada
filter__classificationstringClassification
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post connector with filtering optionsBORNEO_POST_CONNECTOR_WITH_FILTERING_OPTIONSAcciónRetrieves 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.
BORNEO_POST_CONNECTOR_WITH_FILTERING_OPTIONSAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringOptional "nextToken" value from the last API response.
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
filter__namesstring[]Filter based on connector name.
filter__searchstringSearch for connectors by name.
filter__statesstring[]Filter based on connector state.
filter__resourceIdsstring[]Filter based on the resource ID of the data source instance associated with the connector.
filter__activeStatesbooleanFilters out connectors which are not in destroying or destroyed states
filter__connectorIdsstring[]Filter based on the connector IDs.
filter__dataPlaneIdsstring[]Filter based on the data plane in which the connector is deployed.
filter__resourceTypesstring[]Filter based on the resource type that the connector supports.
filter__connectorTypesstring[]Filter based on the connector type.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post current dashboard userBORNEO_POST_CURRENT_DASHBOARD_USERAcciónRetrieves 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.
BORNEO_POST_CURRENT_DASHBOARD_USERAcciónRetrieves 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.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post dashboard reportBORNEO_POST_DASHBOARD_REPORTAcciónCreates 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.
BORNEO_POST_DASHBOARD_REPORTAcciónCreates 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.
Parámetros de entrada
namestringObligatorioName
rolesstring[]Roles
statusstringObligatorioenumStatus
DELETEDONCESCHEDULEDcreatedBystringCreatedby
frequencystringenumThe cron schedule expression to use for a recurring scan. Only a fixed set of cron expressions can be used to run scans at 30 minute, 1 hour, 1 day, or 1 week intervals.
*/30 * * * *0 */1 * * *0 */12 * * *0 */4 * * *0 */6 * * *0 */8 * * *0 0 * * *0 0 * * 00 0 1 * *0 0 1 1,4,7,10 *0 0 1 1,7 *reportTypesstring[]ObligatorioReporttypes
externalEmailstring[]Externalemail
recipientsEmailstring[]Recipientsemail
triggerImmediatelybooleanObligatorioTriggerimmediately
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post data breach informationBORNEO_POST_DATA_BREACH_INFORMATIONAcciónCreates 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.
BORNEO_POST_DATA_BREACH_INFORMATIONAcciónCreates 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.
Parámetros de entrada
languagestringenumLanguage
ardeeneses-ECes-MXfrhiitjaptzhcreatedAtintegerCreatedat
createdBystringCreatedby
kindOfDatastringKindofdata
occurredAtintegerOccurredat
descriptionstringDescription
saveAsDraftbooleanObligatorioSaveasdraft
consequencesstringConsequences
discoveredAtintegerDiscoveredat
howDiscoveredstringHowdiscovered
peopleInformedstringPeopleinformed
wasIntentionalstringWasintentional
shortDescriptionstringObligatorioShortdescription
measuresToPreventstringMeasurestoprevent
affectedPeopleFromstringAffectedpeoplefrom
authoritiesInformedstringAuthoritiesinformed
numberAffectedPeopleintegerNumberaffectedpeople
additionalInformationstring[]Additionalinformation
profilePeopleAffectedstringProfilepeopleaffected
compromisedSensitiveDatastringCompromisedsensitivedata
problemOfSecurityMeasuresstringProblemofsecuritymeasures
securityMeasuresOrProtocolsstringSecuritymeasuresorprotocols
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post discovered recipient by idBORNEO_POST_DISCOVERED_RECIPIENT_BY_IDAcciónUpdates 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.
BORNEO_POST_DISCOVERED_RECIPIENT_BY_IDAcciónUpdates 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.
Parámetros de entrada
discoveredRecipientIdstringObligatorioDiscoveredrecipientid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post filtered access logsBORNEO_POST_FILTERED_ACCESS_LOGSAcciónThe 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.
BORNEO_POST_FILTERED_ACCESS_LOGSAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of logs to return per API call.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
filter__endstringList logs ending in between a specific timestamps with nonoseconds eg. 1715076399359944184.
filter__emailstringFilters all logs with user email eg. "user@example.com".
filter__startstringList logs starting in between a specific timestamps with nonoseconds eg. 1715076388657800827.
filter__searchstringFree-text search on the logs.
filter__requestIdstringList logs from a specific requestId eg. "clvuywyoq009407rj61sxcrpc"
filter__operationNamestringList logs based on operation type eg. "ListConnectors", "CreateOktaConnection".
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post log audit records with filter criteriaBORNEO_POST_LOG_AUDIT_RECORDS_WITH_FILTER_CRITERIAAcciónThe 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.
BORNEO_POST_LOG_AUDIT_RECORDS_WITH_FILTER_CRITERIAAcciónThe 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.
Parámetros de entrada
pageSizeintegerThe maximum number of logs to return per API call.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
filter__endstringList logs ending in between a specific timestamps with nonoseconds eg. 1715076399359944184.
filter__startstringList logs starting in between a specific timestamps with nonoseconds eg. 1715076388657800827.
filter__scanIdstringList logs for a specific scan
filter__searchstringFree-text search on the logs.
filter__categorystringenumCategory
cloudAWScloudAzurecloudGCPconnectordataPlanenotificationscanfilter__accountIdstringList logs for a specific AWS account
filter__connectorIdstringList logs for a specific connector
filter__dataPlaneIdstringList logs for a specific dataPlane
filter__gcpProjectIdstringList logs for a specific GCP project
filter__gcpConnectionIdstringList logs for a specific GCP connection
filter__azureConnectionIdstringList logs for a specific Azure connection
filter__azureSubscriptionIdstringList logs for a specific Azure project
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post resource lineage filterBORNEO_POST_RESOURCE_LINEAGE_FILTERAcciónRetrieves 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.
BORNEO_POST_RESOURCE_LINEAGE_FILTERAcciónRetrieves 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.
Parámetros de entrada
filter__resourceIdstringResourceid
filter__upstreamDepthintegerUpstreamdepth
filter__downstreamDepthintegerDownstreamdepth
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post resource stats with deleted resourcesBORNEO_POST_RESOURCE_STATS_WITH_DELETED_RESOURCESAcciónRetrieves 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.
BORNEO_POST_RESOURCE_STATS_WITH_DELETED_RESOURCESAcciónRetrieves 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.
Parámetros de entrada
includeDeletedResourcesbooleanIncludedeletedresources
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post scan resource statusBORNEO_POST_SCAN_RESOURCE_STATUSAcciónRetrieves 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.
BORNEO_POST_SCAN_RESOURCE_STATUSAcciónRetrieves 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.
Parámetros de entrada
scanIdstringObligatorioThe unique scan ID.
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
filter__namestringName
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Post support chat queryBORNEO_POST_SUPPORT_CHAT_QUERYAcciónThe 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.
BORNEO_POST_SUPPORT_CHAT_QUERYAcciónThe 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.
Parámetros de entrada
querystringObligatorioQuery
sessionIdstringSessionid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Put tom status and noteBORNEO_PUT_TOM_STATUS_AND_NOTEAcciónUpdates 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.
BORNEO_PUT_TOM_STATUS_AND_NOTEAcciónUpdates 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.
Parámetros de entrada
notestringNote
tomIdstringObligatorioTomid
statusstringObligatorioenumStatus of the TOM, i.e. whether the TOM is already implemented, implementation is pending, or the TOM is not implemented.
availableimplementedpendingToImplementdocumentFilesstring[]Uploaded file id list.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Remove dashboard user by usernameBORNEO_REMOVE_DASHBOARD_USER_BY_USERNAMEAcciónRemoves 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.
BORNEO_REMOVE_DASHBOARD_USER_BY_USERNAMEAcciónRemoves 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.
Parámetros de entrada
usernamestringObligatorioUsername
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Reset dashboard user passwordBORNEO_RESET_DASHBOARD_USER_PASSWORDAcciónInitiates 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.
BORNEO_RESET_DASHBOARD_USER_PASSWORDAcciónInitiates 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.
Parámetros de entrada
usernamestringObligatorioUsername
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Resume scan by idBORNEO_RESUME_SCAN_BY_IDAcciónThe 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.
BORNEO_RESUME_SCAN_BY_IDAcciónThe 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.
Parámetros de entrada
scanIdstringObligatorioThe unique scan ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve account details by idBORNEO_RETRIEVE_ACCOUNT_DETAILS_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_ACCOUNT_DETAILS_BY_IDAcciónRetrieves 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.
Parámetros de entrada
accountIdstringObligatorioThe unique Borneo account ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve asset by idBORNEO_RETRIEVE_ASSET_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_ASSET_BY_IDAcciónRetrieves 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.
Parámetros de entrada
assetIdstringObligatorioIdentifier of the asset
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve connector by idBORNEO_RETRIEVE_CONNECTOR_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_CONNECTOR_BY_IDAcciónRetrieves 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.
Parámetros de entrada
connectorIdstringObligatorioThe unique Borneo connector ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve data breach by idBORNEO_RETRIEVE_DATA_BREACH_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_DATA_BREACH_BY_IDAcciónRetrieves 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.
Parámetros de entrada
dataBreachIdstringObligatorioIdentifier of the DataBreach
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve data resource statisticsBORNEO_RETRIEVE_DATA_RESOURCE_STATISTICSAcciónRetrieves 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.
BORNEO_RETRIEVE_DATA_RESOURCE_STATISTICSAcciónRetrieves 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.
Parámetros de entrada
sourceTypestringSourcetype
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve department informationBORNEO_RETRIEVE_DEPARTMENT_INFORMATIONAcciónRetrieves 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.
BORNEO_RETRIEVE_DEPARTMENT_INFORMATIONAcciónRetrieves 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.
Parámetros de entrada
departmentIdstringObligatorioIdentifier of the department.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve discovered document by idBORNEO_RETRIEVE_DISCOVERED_DOCUMENT_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_DISCOVERED_DOCUMENT_BY_IDAcciónRetrieves 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.
Parámetros de entrada
discoveredDocumentIdstringObligatorioDiscovereddocumentid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve discovered infotype by idBORNEO_RETRIEVE_DISCOVERED_INFOTYPE_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_DISCOVERED_INFOTYPE_BY_IDAcciónRetrieves 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.
Parámetros de entrada
discoveredInfotypeIdstringObligatorioDiscoveredinfotypeid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve discovered recipient by idBORNEO_RETRIEVE_DISCOVERED_RECIPIENT_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_DISCOVERED_RECIPIENT_BY_IDAcciónRetrieves 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.
Parámetros de entrada
discoveredRecipientIdstringObligatorioIdentifier of the discovered recipient.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve dpia by idBORNEO_RETRIEVE_DPIA_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_DPIA_BY_IDAcciónRetrieves 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.
Parámetros de entrada
dpiaIdstringObligatorioIdentifier of the DPIA
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve employee details by idBORNEO_RETRIEVE_EMPLOYEE_DETAILS_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_EMPLOYEE_DETAILS_BY_IDAcciónRetrieves 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.
Parámetros de entrada
employeeIdstringObligatorioIdentifier of the employee
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve error details by idBORNEO_RETRIEVE_ERROR_DETAILS_BY_IDAcciónThe 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.
BORNEO_RETRIEVE_ERROR_DETAILS_BY_IDAcciónThe 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.
Parámetros de entrada
errorIdstringObligatorioThe unique resource ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve issue by idBORNEO_RETRIEVE_ISSUE_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_ISSUE_BY_IDAcciónRetrieves 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.
Parámetros de entrada
issueIdstringObligatorioThe unique issue ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve legal document by idBORNEO_RETRIEVE_LEGAL_DOCUMENT_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_LEGAL_DOCUMENT_BY_IDAcciónRetrieves 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.
Parámetros de entrada
documentIdstringObligatorioDocumentid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve lopdp threshold by idBORNEO_RETRIEVE_LOPDP_THRESHOLD_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_LOPDP_THRESHOLD_BY_IDAcciónRetrieves 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.
Parámetros de entrada
lopdpThresholdIdstringObligatorioIdentifier of the Threshold
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve processing activity by idBORNEO_RETRIEVE_PROCESSING_ACTIVITY_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_PROCESSING_ACTIVITY_BY_IDAcciónRetrieves 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.
Parámetros de entrada
processingActivityIdstringObligatorioIdentifier of the Processing Activity
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve recipient detailsBORNEO_RETRIEVE_RECIPIENT_DETAILSAcciónRetrieves 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.
BORNEO_RETRIEVE_RECIPIENT_DETAILSAcciónRetrieves 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.
Parámetros de entrada
recipientIdstringObligatorioIdentifier of the Recipient
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve recipient processing activitiesBORNEO_RETRIEVE_RECIPIENT_PROCESSING_ACTIVITIESAcciónRetrieves 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.
BORNEO_RETRIEVE_RECIPIENT_PROCESSING_ACTIVITIESAcciónRetrieves 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.
Parámetros de entrada
pageSizeintegerThe maximum number of records to return per API call. If more records are available, the response will be truncated and will contain a "nextToken" value, which can be used to return additional records.
nextTokenstringThe `nextToken` from the last page of results to retrieve the next page of results.
recipientIdstringObligatorioIdentifier of the Recipient
sort__orderstringenumOrder
ASCDESCsort__columnstringThe column name to sort on.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve resource catalog by idBORNEO_RETRIEVE_RESOURCE_CATALOG_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_RESOURCE_CATALOG_BY_IDAcciónRetrieves 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.
Parámetros de entrada
resourceIdstringObligatorioThe unique resource ID.
includeParentDetailsbooleanIncludeparentdetails
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve resource columnsBORNEO_RETRIEVE_RESOURCE_COLUMNSAcciónRetrieves 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.
BORNEO_RETRIEVE_RESOURCE_COLUMNSAcciónRetrieves 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.
Parámetros de entrada
dataspacestring[]Dataspace
searchKeystringSearchkey
resourceIdstring[]Resourceid
sourceTypestringSourcetype
parentResourceIdstringObligatorioParentresourceid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Retrieve tom by idBORNEO_RETRIEVE_TOM_BY_IDAcciónRetrieves 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.
BORNEO_RETRIEVE_TOM_BY_IDAcciónRetrieves 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.
Parámetros de entrada
tomIdstringObligatorioIdentifier of the TOM
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Scan legal document byidBORNEO_SCAN_LEGAL_DOCUMENT_BY_IDAcciónInitiates 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.
BORNEO_SCAN_LEGAL_DOCUMENT_BY_IDAcciónInitiates 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.
Parámetros de entrada
documentIdstringObligatorioDocumentid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Stop scan via scanidBORNEO_STOP_SCAN_VIA_SCAN_IDAcciónStops 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.
BORNEO_STOP_SCAN_VIA_SCAN_IDAcciónStops 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.
Parámetros de entrada
scanIdstringObligatorioThe unique scan ID.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Submit chat feedbackBORNEO_SUBMIT_CHAT_FEEDBACKAcciónThe 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.
BORNEO_SUBMIT_CHAT_FEEDBACKAcciónThe 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.
Parámetros de entrada
postIdstringPostid
ratingintegerRating
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Submit detailed scan resultsBORNEO_SUBMIT_DETAILED_SCAN_RESULTSAcciónRetrieves 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.
BORNEO_SUBMIT_DETAILED_SCAN_RESULTSAcciónRetrieves 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.
Parámetros de entrada
pageIdstringPage ID for one of the pages produced by the scan.
scanIdstringObligatorioScan ID of the scan that produced the inspection result.
resourceIdstringObligatorioResource ID for the resource for which the page was produced.
scanIterationIdstringObligatorioScanIteration ID of the scan that produced the inspection result.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Trigger dashboard report by report idBORNEO_TRIGGER_DASHBOARD_REPORT_BY_REPORT_IDAcciónTriggers 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.
BORNEO_TRIGGER_DASHBOARD_REPORT_BY_REPORT_IDAcciónTriggers 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.
Parámetros de entrada
dashboardReportIdstringObligatorioDashboardreportid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update asset information by idBORNEO_UPDATE_ASSET_INFORMATION_BY_IDAcciónThe 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.
BORNEO_UPDATE_ASSET_INFORMATION_BY_IDAcciónThe 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.
Parámetros de entrada
namestringObligatorioName of the asset
typestringObligatorioenumIndicates the type of the asset. An asset can be one of the several options.
applicationscloudServicescommunicationsdataInformationexternalStoragefilingRoomfurniturehardwarehostingotherpaperDocumentationprinter+3tomIdsstring[]Tomids
assetIdstringObligatorioIdentifier of the asset
locationIdstringLocationid
locationTypestringenumLocationtype
externalofficeremote
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update category infotypesBORNEO_UPDATE_CATEGORY_INFOTYPESAcciónUpdates 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.
BORNEO_UPDATE_CATEGORY_INFOTYPESAcciónUpdates 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.
Parámetros de entrada
infotypesstring[]ObligatorioThe list of infotypes that belong to this category.
descriptionstringThe description of the infotype category.
categoryLabelstringObligatorioThe name of the infotype category.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update dashboard report frequency and recipientsBORNEO_UPDATE_DASHBOARD_REPORT_FREQUENCY_AND_RECIPIENTSAcciónUpdates 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.
BORNEO_UPDATE_DASHBOARD_REPORT_FREQUENCY_AND_RECIPIENTSAcciónUpdates 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.
Parámetros de entrada
rolesstring[]Roles
frequencystringenumThe cron schedule expression to use for a recurring scan. Only a fixed set of cron expressions can be used to run scans at 30 minute, 1 hour, 1 day, or 1 week intervals.
*/30 * * * *0 */1 * * *0 */12 * * *0 */4 * * *0 */6 * * *0 */8 * * *0 0 * * *0 0 * * 00 0 1 * *0 0 1 1,4,7,10 *0 0 1 1,7 *externalEmailstring[]Externalemail
recipientsEmailstring[]Recipientsemail
dashboardReportIdstringObligatorioDashboardreportid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update dashboard user detailsBORNEO_UPDATE_DASHBOARD_USER_DETAILSAcciónUpdates 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.
BORNEO_UPDATE_DASHBOARD_USER_DETAILSAcciónUpdates 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.
Parámetros de entrada
namestringObligatorioName
usernamestringObligatorioUsername
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update dashboard user rolesBORNEO_UPDATE_DASHBOARD_USER_ROLESAcciónUpdates 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.
BORNEO_UPDATE_DASHBOARD_USER_ROLESAcciónUpdates 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.
Parámetros de entrada
usernamestringObligatorioUsername
organisationsobject[]ObligatorioOrganisations
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update data breach entryBORNEO_UPDATE_DATA_BREACH_ENTRYAcciónThe 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.
BORNEO_UPDATE_DATA_BREACH_ENTRYAcciónThe 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.
Parámetros de entrada
createdBystringCreatedby
kindOfDatastringKindofdata
occurredAtintegerOccurredat
descriptionstringDescription
saveAsDraftbooleanObligatorioSaveasdraft
consequencesstringConsequences
dataBreachIdstringObligatorioIdentifier of the DataBreach
discoveredAtintegerDiscoveredat
howDiscoveredstringHowdiscovered
peopleInformedstringPeopleinformed
wasIntentionalstringWasintentional
shortDescriptionstringObligatorioShortdescription
measuresToPreventstringMeasurestoprevent
affectedPeopleFromstringAffectedpeoplefrom
authoritiesInformedstringAuthoritiesinformed
numberAffectedPeopleintegerNumberaffectedpeople
additionalInformationstring[]Additionalinformation
profilePeopleAffectedstringProfilepeopleaffected
compromisedSensitiveDatastringCompromisedsensitivedata
problemOfSecurityMeasuresstringProblemofsecuritymeasures
securityMeasuresOrProtocolsstringSecuritymeasuresorprotocols
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update department nameBORNEO_UPDATE_DEPARTMENT_NAMEAcciónThis 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.
BORNEO_UPDATE_DEPARTMENT_NAMEAcciónThis 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.
Parámetros de entrada
namestringName
departmentIdstringObligatorioIdentifier of the department.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update discovered document statusBORNEO_UPDATE_DISCOVERED_DOCUMENT_STATUSAcciónThis 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.
BORNEO_UPDATE_DISCOVERED_DOCUMENT_STATUSAcciónThis 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.
Parámetros de entrada
statusstringObligatorioenumStatus
ADDEDDELETEDDOMAIN_DELETEDIGNOREDNEWdiscoveredDocumentIdstringObligatorioDiscovereddocumentid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update discovered infotype statusBORNEO_UPDATE_DISCOVERED_INFOTYPE_STATUSAcciónUpdates 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.
BORNEO_UPDATE_DISCOVERED_INFOTYPE_STATUSAcciónUpdates 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.
Parámetros de entrada
statusstringObligatorioenumStatus
APPROVEDAPPROVED_AUTOMATICALLYDELETEDIGNOREDNEWNOT_PRESENTREQUESTEDdiscoveredInfotypeIdstringObligatorioDiscoveredinfotypeid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update domain detailsBORNEO_UPDATE_DOMAIN_DETAILSAcciónUpdates 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.
BORNEO_UPDATE_DOMAIN_DETAILSAcciónUpdates 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.
Parámetros de entrada
namestringObligatorioName of the domain.
domainIdstringObligatorioIdentifier of the domain.
frequencystringObligatorioenumFrequency of polling for a domain. Manual polling means that this domain will not be polled automatically.
12h1d1w30d6hmanual
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update dpia by idBORNEO_UPDATE_DPIA_BY_IDAcciónUpdates 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.
BORNEO_UPDATE_DPIA_BY_IDAcciónUpdates 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.
Parámetros de entrada
dpiaIdstringObligatorioIdentifier of the DPIA
statusstringObligatorioenumThe status of the DPIA. If a DPIA is saved as activated, several fields are required
activateddrafttranslationsobjectTranslations
integrity__impactsobject[]List of impacts that integrity risk can have. At least one element is necessary DPIA is saved as activated
integrity__threatsobject[]List of threats that integrity risk can have. At least one element is necessary DPIA is saved as activated
additionalInformationstringAdditionalinformation
availability__impactsobject[]List of impacts that availability risk can have. At least one element is necessary DPIA is saved as activated
availability__threatsobject[]List of threats that availability risk can have. At least one element is necessary DPIA is saved as activated
integrity__plannedTomsstring[]List of TOMs that are planned to be implemented to prevent integrity risk. At least one element is necessary DPIA is saved as activated
integrity__riskSourcesobject[]List of risk sources that integrity risk can have. At least one element is necessary DPIA is saved as activated
confidentiality__impactsobject[]List of impacts that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
confidentiality__threatsobject[]List of threats that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
availability__plannedTomsstring[]List of TOMs planned to be implemented and that applies to the availability risk. At least one element is necessary DPIA is saved as activated
availability__riskSourcesobject[]List of risk sources that availability risk can have. At least one element is necessary DPIA is saved as activated
integrity__impactsCommentstringComment to add additional information about the integrity impacts
integrity__threatsCommentstringComment to add additional information about the integrity threats
privacyFramework__consentstringField to describe the measures to ensure that the consent of the data subjects has been obtained and how the given consent can be revoked Mandatory if DPIA is saved as activated and the lawfulness "consent_person_concerned" selected
additionalInformationFilesstring[]Additionalinformationfiles
integrity__baselineCommentstringComment to add additional information about the baseline risk of the integrity
integrity__implementedTomsstring[]List of TOMs that are implemented to prevent integrity risk. At least one element is necessary DPIA is saved as activated
privacyFramework__accuracystringField to explain if the data processed is accurate, high quality and up-to-date Mandatory if DPIA is saved as activated
integrity__baselineSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowprivacyFramework__retentionbooleanIs the retention period lawful and clearly defined? Mandatory if DPIA is saved as activated
availability__impactsCommentstringComment to add additional information about the impact
availability__threatsCommentstringComment to add additional information about the threat
confidentiality__plannedTomsstring[]List of TOMs that are planned to be implemented to prevent confidentiality risk. At least one element is necessary DPIA is saved as activated
confidentiality__riskSourcesobject[]List of risk sources that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
availability__baselineCommentstringComment to add additional information about the baseline risk of the availablity
availability__implementedTomsstring[]List of implemented TOMs that applies to the availability risk. At least one element is necessary DPIA is saved as activated
integrity__baselineLikelihoodstringenumBaselinelikelihood
likelylimitedmaximumnegligibleunlikelyintegrity__plannedTomsCommentstringComment to add additional information about planned TOMs to prevent integrity risk
integrity__riskSourcesCommentstringComment to add additional information about the integrity risk sources
availability__baselineSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowintegrity__residualRiskCommentstringComment to add additional information about the residual risk of the integrity
privacyFramework__transparencystringField to describe what kind of notice information is given to data subjects about this processing, and how is it provided to the data subjects? Mandatory if DPIA is saved as activated
confidentiality__impactsCommentstringComment to add additional information about the confidentiality risk impacts
confidentiality__threatsCommentstringComment to add additional information about the confidentiality risk threats
integrity__residualRiskSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowavailability__baselineLikelihoodstringenumBaselinelikelihood
likelylimitedmaximumnegligibleunlikelyavailability__plannedTomsCommentstringComment to add additional information about the planned TOMs
availability__riskSourcesCommentstringComment to add additional information about the availability risk sources
confidentiality__baselineCommentstringComment to add additional information about the baseline risk of the confidentiality
confidentiality__implementedTomsstring[]List of TOMs that are implemented to prevent confidentiality risk. At least one element is necessary DPIA is saved as activated
availability__residualRiskCommentstringComment to add additional information about the residual risk of the availability
confidentiality__baselineSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowintegrity__implementedTomsCommentstringComment to add additional information about implemented TOMs to prevent integrity risk
integrity__residualRiskLikelihoodstringenumResidualrisklikelihood
likelylimitedmaximumnegligibleunlikelyavailability__residualRiskSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowprivacyFramework__dataMinimisationstringField to explain if the data collected adequate, relevant, and limited to what is necessary concerning the purposes for which it is processed Mandatory if DPIA is saved as activated
privacyFramework__retentionCommentstringField to add comment on the retention period
confidentiality__baselineLikelihoodstringenumBaselinelikelihood
likelylimitedmaximumnegligibleunlikelyconfidentiality__plannedTomsCommentstringComment to add additional information about planned TOMs to prevent confidentiality risk
confidentiality__riskSourcesCommentstringComment to add additional information about the confidentiality risk sources
privacyFramework__additionalCommentstringField to add more information related to the privacy framework of the DPIA
privacyFramework__purposeLimitationstringField to explain the clear, specific and legitimate purpose of conducting the processing activity. Mandatory if DPIA is saved as activated
availability__implementedTomsCommentstringComment to add additional information about the implemented TOMs
availability__residualRiskLikelihoodstringenumResidualrisklikelihood
likelylimitedmaximumnegligibleunlikelyconfidentiality__residualRiskCommentstringComment to add additional information about the residual risk of the confidentiality
confidentiality__residualRiskSeveritystringenumRepresents the severity of a risk
highlowmediumvery_highvery_lowprivacyFramework__dataRightsExercisedstringField to describe how do data subjects exercise their data subject rights? Mandatory if DPIA is saved as activated
confidentiality__implementedTomsCommentstringComment to add additional information about implemented TOMs to prevent confidentiality risk
confidentiality__residualRiskLikelihoodstringenumResidualrisklikelihood
likelylimitedmaximumnegligibleunlikely
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update employee by idBORNEO_UPDATE_EMPLOYEE_BY_IDAcciónUpdates 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.
BORNEO_UPDATE_EMPLOYEE_BY_IDAcciónUpdates 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.
Parámetros de entrada
nifstringThe NIF (Spanish Tax Identification Number) of the employee
namestringThe name of the employee
emailstringThe email of the employee. Has to be unique within the company.
endDatestringDate when the employee end to work in your company
managerstringThe employee"s direct manager.
surnamestringThe surname of the employee
positionstringThe position in the company of the employee
startDatestringDate when the employee began to work in your company
departmentstringThe department of the employee
employeeIdstringObligatorioIdentifier of the employee
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update headquarter details by idBORNEO_UPDATE_HEADQUARTER_DETAILS_BY_IDAcciónUpdates 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.
BORNEO_UPDATE_HEADQUARTER_DETAILS_BY_IDAcciónUpdates 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.
Parámetros de entrada
citystringObligatorioThe locality of the headquarter
namestringObligatorioThe name of the headquarter
tomIdsstring[]Tomids
addressstringObligatorioThe address of the headquarter
countrystringObligatorio2 letter code that identifies a country.
zipcodestringThe zipcode of the headquarter
headquarterIdstringObligatorioThe identifier of the headquarter
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update lopdp threshold by idBORNEO_UPDATE_LOPDP_THRESHOLD_BY_IDAcciónUpdates 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.
BORNEO_UPDATE_LOPDP_THRESHOLD_BY_IDAcciónUpdates 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.
Parámetros de entrada
statusstringenumStatus of the threshold. Can be draft or activated.
activateddraftcommentstringAdditional information related to the Threshold
lopdpThresholdIdstringObligatorioIdentifier of the Threshold
additionalCommentbooleanAdditionalcomment
largeScaleObservationbooleanLargescaleobservation
sensitiveOrSpecialDatabooleanSensitiveorspecialdata
rightsRiskProcessingDatabooleanRightsriskprocessingdata
freedomRiskProcessingDatabooleanFreedomriskprocessingdata
innovativeTechnologiesUsedbooleanInnovativetechnologiesused
processingPersonalDataRiskbooleanProcessingpersonaldatarisk
specialCategoryDataProcessedbooleanSpecialcategorydataprocessed
systematicPersonalAssessmentbooleanSystematicpersonalassessment
processingVulnerableDataSubjectbooleanProcessingvulnerabledatasubject
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update processing activity detailsBORNEO_UPDATE_PROCESSING_ACTIVITY_DETAILSAcciónThis 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.
BORNEO_UPDATE_PROCESSING_ACTIVITY_DETAILSAcciónThis 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.
Parámetros de entrada
namestringObligatorioName of the processing activity
ownerstringOwner
activebooleanObligatorioFlag to create the processing activity as activated or draft
assetsstring[]List assets ids related to the processing activity.
modelIdstringModelid
purposestringPurpose of the processing activity
dataTypesstring[]Datatypes
infotypesstring[]List of info types related with the processing activity.
recipientsobject[]List of recipients related with the processing activity.
companyRolestring[]Companyrole
dataSourcesstring[]Datasources
departmentsstring[]List departments related with the processing activity.
lawfulBasisobject[]List of Lawfulness types affected by a processing activity
dataSubjectsstring[]List of Data Subjects affected by the processing activity
isDataStoredbooleanIndicates if you store the data.
translationsobjectTranslations
contactPersonstringContact person for the processing activity.
additionalInfostringText to add more information about the processing activity
infotypeVolumestringenumRanges of the processed infotype volume.
0-10001000-1000010000-100000100000+managementMethodsobject[]Managementmethods
infotypeCategoriesstring[]List of info types categories related with the processing activity.
showOnRopaDocumentbooleanShowonropadocument
additionalInfoFilesstring[]List of uploaded file ids.
processingFrequencystringenumData processing frequency.
is_systematicnot_systematicprocessingActivityIdstringObligatorioIdentifier of the Processing Activity
dataFlowRelationshipsobject[]Dataflowrelationships
retentionPeriod__unitstringenumUnit of time that is used for retention period
daymonthweekyearretentionPeriodCommentstringAdditional information related to the retention period
retentionPeriod__valueintegerValue
areAccessRequestsManagedbooleanIndicates if the data subject access requests are managed.
processingFrequencyCommentstringProcessingfrequencycomment
processingActivitiesAsDataSourcesstring[]Processingactivitiesasdatasources
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update recipient details by idBORNEO_UPDATE_RECIPIENT_DETAILS_BY_IDAcciónUpdates 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.
BORNEO_UPDATE_RECIPIENT_DETAILS_BY_IDAcciónUpdates 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.
Parámetros de entrada
dpastringThe url to the DPA of the recipient
namestringObligatorioName of the recipient. Has to be unique, 2 different recipients can"t have the same name.
rolestring[]Role
statestringenum2 letter code that identifies the state of the recipient. It only applies when the recipient country is US
AKALARAZCACOCTDCDEFLGAHI+39statusstringObligatorioenumThe status of the recipient. Can be archived or validated.
archivedvalidatedcountrystring2 letter code that identifies a country.
dpaFilesstring[]List of uploaded file ids.
dpaStatusstringenumThe status of the DPA of the recipient. Attached if the DPA is provided. Not required when it"s not necessary to provide the information. Requested when we ask for the DPA and we are waiting for it.
attachednotRequiredrequestedcategoriesstring[]list of recipient category
recipientIdstringObligatorioIdentifier of the Recipient
businessNamestringBusiness name of the recipient
recipientStatestringenumRecipientstate
activeassessmentsubProcessorIdsstring[]Subprocessorids
automationStatusstringenumAutomationstatus
createdignorednewdataStorageLocationstring[]ObligatorioList of countries where the data related to this recipient are stored
recipientWarrantiesstring[]ObligatorioList of lawful basis types that applies to the recipient.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update recipient status via idBORNEO_UPDATE_RECIPIENT_STATUS_VIA_IDAcciónUpdates 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.
BORNEO_UPDATE_RECIPIENT_STATUS_VIA_IDAcciónUpdates 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.
Parámetros de entrada
statusstringenumThe status of the recipient. Can be archived or validated.
archivedvalidatedrecipientIdstringObligatorioIdentifier of the Recipient
automationStatusstringenumAutomationstatus
createdignorednew
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Update threshold by idBORNEO_UPDATE_THRESHOLD_BY_IDAcciónUpdates 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.
BORNEO_UPDATE_THRESHOLD_BY_IDAcciónUpdates 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.
Parámetros de entrada
statusstringenumStatus of the threshold. Can be draft or activated.
activateddraftcommentstringAdditional information related to the Threshold
blacklistbooleanIndicates if the data processing is included in a black list
thresholdIdstringObligatorioIdentifier of the Threshold
translationsobjectTranslations
classifyingDataSubjectbooleanIndicates if this data processing is assessing or classifying data subjects
automatedDecisionMakingbooleanIndicates if there is automated decision-making with legal effect, or similarly significant effect involved
largeScaleDataProcessingbooleanIndicates if is a large scale data processing
innovativeTechnologiesUsedbooleanIndicates if there are innovative technologies used
matchingMergingRecordsInvolvedbooleanIndicates if there is matching or merging of the records involved
processingVulnerableDataSubjectbooleanIndicates if there is processing of data of vulnerable data subjects
systematicMonitoringDataSubjectbooleanIndicates if there is systematic monitoring of data subjects involved
largeScaleProcessingSensitiveDatabooleanIndicates if the data processing is large scale processing of sensitive data.
monitoringPubliclyAccessibleAreasbooleanIndicates if the data processing is systematic and large scale monitoring of publicly accessible areas involved.
processingConfidentialSensitiveDatabooleanIndicates if there is processing of confidential or sensitive data
preventDataSubjectsExercisingTheirRightsbooleanIndicates if the data processing prevents the data subjects from exercising their rights, using a service or performing a contract
extensiveAutomatedEvaluationCharacteristicsbooleanIndicates if the data processing involve any systematic, extensive and automated evaluation of personal characteristics with effect for the data subjects.
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Verify email with id and tokenBORNEO_VERIFY_EMAIL_WITH_ID_AND_TOKENAcciónCompletes 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.
BORNEO_VERIFY_EMAIL_WITH_ID_AND_TOKENAcciónCompletes 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.
Parámetros de entrada
tokenstringObligatorioToken
verificationIdstringObligatorioVerificationid
Parámetros de salida
dataobjectObligatorioerrorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not