API - Corsair

Every borneo.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Accounts

getCloudAccountById

accounts.getCloudAccountById Get cloud account by id Risk: read

await corsair.borneo.api.accounts.getCloudAccountById({});

Input

Name	Type	Required	Description
`cloudAccountId`	`string`	Yes	The cloud-provider specific account ID, e.g. a 12-digit AWS account ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    cloudAccountId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postAccountsWithFilterAndSortOptions

accounts.postAccountsWithFilterAndSortOptions Post accounts with filter and sort options Risk: read

await corsair.borneo.api.accounts.postAccountsWithFilterAndSortOptions({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Optional “nextToken” value from the last API response.
`sort__order`	`ASC \| DESC`	No	Order
`filter__type`	`string`	No	Filter accounts by account type.
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Search for accounts by name.
`filter__status`	`string[]`	No	Filter accounts by status.
`filter__accountId`	`string[]`	No	Filter accounts by the Borneo account ID.
`filter__activeStates`	`boolean`	No	Filters out accounts which are not in deleting or deleted states
`filter__cloudAccountId`	`string[]`	No	Filter accounts by the cloud-provider specific account ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    filter__type?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    filter__accountId?: string,
    filter__activeStates?: boolean,
    filter__cloudAccountId?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveAccountDetailsById

accounts.retrieveAccountDetailsById Retrieve account details by id Risk: read

await corsair.borneo.api.accounts.retrieveAccountDetailsById({});

Input

Name	Type	Required	Description
`accountId`	`string`	Yes	The unique Borneo account ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Assets

createNewAsset

assets.createNewAsset Create new asset Risk: write

await corsair.borneo.api.assets.createNewAsset({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name of the asset to create
`type`	`applications \| cloudServices \| communications \| dataInformation \| externalStorage \| filingRoom \| furniture \| hardware \| hosting \| other \| paperDocumentation \| printer \| server \| shredder \| videoSurveillance`	Yes	Indicates the type of the asset. An asset can be one of the several options.
`tomIds`	`string[]`	No	Tomids
`createdAt`	`number`	No	Createdat
`locationId`	`string`	No	Locationid
`locationType`	`external \| office \| remote`	No	Locationtype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    type?: string,
    locationType?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteAssetById

assets.deleteAssetById Delete asset by id Risk: destructive

await corsair.borneo.api.assets.deleteAssetById({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	Identifier of the asset

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

filterAndSortAssetsList

assets.filterAndSortAssetsList Filter and sort assets list Risk: read

await corsair.borneo.api.assets.filterAndSortAssetsList({});

Input

Name	Type	Required	Description
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`maxResults`	`number`	No	The 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__order`	`ASC \| DESC`	No	Order
`filter__type`	`applications \| cloudServices \| communications \| dataInformation \| externalStorage \| filingRoom \| furniture \| hardware \| hosting \| other \| paperDocumentation \| printer \| server \| shredder \| videoSurveillance[]`	No	Type
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the asset name.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nextToken?: string,
    maxResults?: number,
    filter__type?: string,
    sort__column?: string,
    filter__search?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveAssetById

assets.retrieveAssetById Retrieve asset by id Risk: read

await corsair.borneo.api.assets.retrieveAssetById({});

Input

Name	Type	Required	Description
`assetId`	`string`	Yes	Identifier of the asset

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateAssetInformationById

assets.updateAssetInformationById Update asset information by id Risk: write

await corsair.borneo.api.assets.updateAssetInformationById({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name of the asset
`type`	`applications \| cloudServices \| communications \| dataInformation \| externalStorage \| filingRoom \| furniture \| hardware \| hosting \| other \| paperDocumentation \| printer \| server \| shredder \| videoSurveillance`	Yes	Indicates the type of the asset. An asset can be one of the several options.
`tomIds`	`string[]`	No	Tomids
`assetId`	`string`	Yes	Identifier of the asset
`locationId`	`string`	No	Locationid
`locationType`	`external \| office \| remote`	No	Locationtype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    type?: string,
    locationType?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Audit

listEventsWithFilters

audit.listEventsWithFilters List events with filters Risk: read

await corsair.borneo.api.audit.listEventsWithFilters({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	Select
`pageSize`	`number`	No	Pagesize
`nextToken`	`string`	No	Nexttoken
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__scanId`	`string[]`	No	Scanid
`filter__search`	`string`	No	Search
`filter__userId`	`string[]`	No	Userid
`filter__eventId`	`string[]`	No	Eventid
`filter__issueId`	`string[]`	No	Issueid
`filter__issueType`	`string[]`	No	Issuetype
`filter__resourceId`	`string[]`	No	Resourceid
`filter__newInfotypeFound`	`boolean`	No	Newinfotypefound

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    sort__column?: string,
    filter__newInfotypeFound?: boolean,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postFilteredAccessLogs

audit.postFilteredAccessLogs Post filtered access logs Risk: read

await corsair.borneo.api.audit.postFilteredAccessLogs({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The maximum number of logs to return per API call.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`filter__end`	`string`	No	List logs ending in between a specific timestamps with nonoseconds eg. 1715076399359944184.
`filter__email`	`string`	No	Filters all logs with user email eg. “user@example.com”.
`filter__start`	`string`	No	List logs starting in between a specific timestamps with nonoseconds eg. 1715076388657800827.
`filter__search`	`string`	No	Free-text search on the logs.
`filter__requestId`	`string`	No	List logs from a specific requestId eg. “clvuywyoq009407rj61sxcrpc”
`filter__operationName`	`string`	No	List logs based on operation type eg. “ListConnectors”, “CreateOktaConnection”.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    filter__end?: string,
    filter__email?: string,
    filter__start?: string,
    filter__search?: string,
    filter__requestId?: string,
    filter__operationName?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postLogAuditRecordsWithFilterCriteria

audit.postLogAuditRecordsWithFilterCriteria Post log audit records with filter criteria Risk: read

await corsair.borneo.api.audit.postLogAuditRecordsWithFilterCriteria({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The maximum number of logs to return per API call.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`filter__end`	`string`	No	List logs ending in between a specific timestamps with nonoseconds eg. 1715076399359944184.
`filter__start`	`string`	No	List logs starting in between a specific timestamps with nonoseconds eg. 1715076388657800827.
`filter__scanId`	`string`	No	List logs for a specific scan
`filter__search`	`string`	No	Free-text search on the logs.
`filter__category`	`cloudAWS \| cloudAzure \| cloudGCP \| connector \| dataPlane \| notification \| scan`	No	Category
`filter__accountId`	`string`	No	List logs for a specific AWS account
`filter__connectorId`	`string`	No	List logs for a specific connector
`filter__dataPlaneId`	`string`	No	List logs for a specific dataPlane
`filter__gcpProjectId`	`string`	No	List logs for a specific GCP project
`filter__gcpConnectionId`	`string`	No	List logs for a specific GCP connection
`filter__azureConnectionId`	`string`	No	List logs for a specific Azure connection
`filter__azureSubscriptionId`	`string`	No	List logs for a specific Azure project

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    filter__end?: string,
    filter__start?: string,
    filter__scanId?: string,
    filter__search?: string,
    filter__category?: string,
    filter__accountId?: string,
    filter__connectorId?: string,
    filter__dataPlaneId?: string,
    filter__gcpProjectId?: string,
    filter__gcpConnectionId?: string,
    filter__azureConnectionId?: string,
    filter__azureSubscriptionId?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Breaches

deleteDataBreachById

breaches.deleteDataBreachById Delete data breach by id Risk: destructive

await corsair.borneo.api.breaches.deleteDataBreachById({});

Input

Name	Type	Required	Description
`dataBreachId`	`string`	Yes	Databreachid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

evaluateDataBreachImpact

breaches.evaluateDataBreachImpact Evaluate data breach impact Risk: write

await corsair.borneo.api.breaches.evaluateDataBreachImpact({});

Input

Name	Type	Required	Description
`role`	`controller \| independent_controller \| joint_controller \| processor \| sub_processor`	No	Role of the recipient.
`evaluation`	`string`	No	Evaluation
`saveAsDraft`	`boolean`	Yes	Saveasdraft
`dataBreachId`	`string`	Yes	Identifier of the DataBreach
`reportLanguage`	`ar \| de \| en \| es \| es-EC \| es-MX \| fr \| hi \| it \| ja \| pt \| zh`	No	Reportlanguage
`companiesAffected`	`string`	No	Companiesaffected
`processorNotified`	`boolean`	No	Processornotified
`dataBreachLocation`	`ourOrganisation \| thirdPartyProcessor`	No	Databreachlocation
`processorsInvolved`	`string`	No	Processorsinvolved
`authoritiesNotified`	`boolean`	No	Authoritiesnotified
`dataBreachController`	`string`	No	Databreachcontroller
`dataSubjectsNotified`	`boolean`	No	Datasubjectsnotified

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    role?: string,
    reportLanguage?: string,
    dataBreachLocation?: string,
    authoritiesNotified?: boolean,
    dataBreachController?: string,
    dataSubjectsNotified?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

fetchDataBreachEvaluation

breaches.fetchDataBreachEvaluation Fetch data breach evaluation Risk: read

await corsair.borneo.api.breaches.fetchDataBreachEvaluation({});

Input

Name	Type	Required	Description
`dataBreachId`	`string`	Yes	Identifier of the DataBreach

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDataBreachesWithFilters

breaches.listDataBreachesWithFilters List data breaches with filters Risk: read

await corsair.borneo.api.breaches.listDataBreachesWithFilters({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__owner`	`string[]`	No	Owner
`filter__search`	`string`	No	Free-form text search to apply to data breaches short description.
`filter__status`	`string[]`	No	Status
`filter__authoritiesNotified`	`boolean[]`	No	Authoritiesnotified

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__authoritiesNotified?: boolean,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDataBreachFilters

breaches.listDataBreachFilters List data breach filters Risk: read

await corsair.borneo.api.breaches.listDataBreachFilters({});

Input

Name	Type	Required	Description
`filterType`	`owner \| status`	Yes	Filtertype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postDataBreachInformation

breaches.postDataBreachInformation Post data breach information Risk: write

await corsair.borneo.api.breaches.postDataBreachInformation({});

Input

Name	Type	Required	Description
`language`	`ar \| de \| en \| es \| es-EC \| es-MX \| fr \| hi \| it \| ja \| pt \| zh`	No	Language
`createdAt`	`number`	No	Createdat
`createdBy`	`string`	No	Createdby
`kindOfData`	`string`	No	Kindofdata
`occurredAt`	`number`	No	Occurredat
`description`	`string`	No	Description
`saveAsDraft`	`boolean`	Yes	Saveasdraft
`consequences`	`string`	No	Consequences
`discoveredAt`	`number`	No	Discoveredat
`howDiscovered`	`string`	No	Howdiscovered
`peopleInformed`	`string`	No	Peopleinformed
`wasIntentional`	`string`	No	Wasintentional
`shortDescription`	`string`	Yes	Shortdescription
`measuresToPrevent`	`string`	No	Measurestoprevent
`affectedPeopleFrom`	`string`	No	Affectedpeoplefrom
`authoritiesInformed`	`string`	No	Authoritiesinformed
`numberAffectedPeople`	`number`	No	Numberaffectedpeople
`additionalInformation`	`string[]`	No	Additionalinformation
`profilePeopleAffected`	`string`	No	Profilepeopleaffected
`compromisedSensitiveData`	`string`	No	Compromisedsensitivedata
`problemOfSecurityMeasures`	`string`	No	Problemofsecuritymeasures
`securityMeasuresOrProtocols`	`string`	No	Securitymeasuresorprotocols

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    language?: string,
    authoritiesInformed?: string,
    numberAffectedPeople?: number,
    additionalInformation?: string,
    profilePeopleAffected?: string,
    compromisedSensitiveData?: string,
    problemOfSecurityMeasures?: string,
    securityMeasuresOrProtocols?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDataBreachById

breaches.retrieveDataBreachById Retrieve data breach by id Risk: read

await corsair.borneo.api.breaches.retrieveDataBreachById({});

Input

Name	Type	Required	Description
`dataBreachId`	`string`	Yes	Identifier of the DataBreach

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDataBreachEntry

breaches.updateDataBreachEntry Update data breach entry Risk: write

await corsair.borneo.api.breaches.updateDataBreachEntry({});

Input

Name	Type	Required	Description
`createdBy`	`string`	No	Createdby
`kindOfData`	`string`	No	Kindofdata
`occurredAt`	`number`	No	Occurredat
`description`	`string`	No	Description
`saveAsDraft`	`boolean`	Yes	Saveasdraft
`consequences`	`string`	No	Consequences
`dataBreachId`	`string`	Yes	Identifier of the DataBreach
`discoveredAt`	`number`	No	Discoveredat
`howDiscovered`	`string`	No	Howdiscovered
`peopleInformed`	`string`	No	Peopleinformed
`wasIntentional`	`string`	No	Wasintentional
`shortDescription`	`string`	Yes	Shortdescription
`measuresToPrevent`	`string`	No	Measurestoprevent
`affectedPeopleFrom`	`string`	No	Affectedpeoplefrom
`authoritiesInformed`	`string`	No	Authoritiesinformed
`numberAffectedPeople`	`number`	No	Numberaffectedpeople
`additionalInformation`	`string[]`	No	Additionalinformation
`profilePeopleAffected`	`string`	No	Profilepeopleaffected
`compromisedSensitiveData`	`string`	No	Compromisedsensitivedata
`problemOfSecurityMeasures`	`string`	No	Problemofsecuritymeasures
`securityMeasuresOrProtocols`	`string`	No	Securitymeasuresorprotocols

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    authoritiesInformed?: string,
    numberAffectedPeople?: number,
    additionalInformation?: string,
    profilePeopleAffected?: string,
    compromisedSensitiveData?: string,
    problemOfSecurityMeasures?: string,
    securityMeasuresOrProtocols?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Name	Type	Required	Description
`infotypes`	`string[]`	Yes	The list of infotypes that belong to this category.
`description`	`string`	No	Description of the infotype category.
`categoryLabel`	`string`	Yes	The name of the infotype category.

Name	Type	Required	Description
`categoryLabel`	`string`	Yes	The name of the infotype category.

Name	Type	Required	Description
`categoryLabel`	`string`	Yes	The name of the infotype category.

Name	Type	Required	Description
`infotypes`	`string[]`	Yes	The list of infotypes that belong to this category.
`description`	`string`	No	The description of the infotype category.
`categoryLabel`	`string`	Yes	The name of the infotype category.

Connectors

postConnectorWithFilteringOptions

connectors.postConnectorWithFilteringOptions Post connector with filtering options Risk: read

await corsair.borneo.api.connectors.postConnectorWithFilteringOptions({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Optional “nextToken” value from the last API response.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__names`	`string[]`	No	Filter based on connector name.
`filter__search`	`string`	No	Search for connectors by name.
`filter__states`	`string[]`	No	Filter based on connector state.
`filter__resourceIds`	`string[]`	No	Filter based on the resource ID of the data source instance associated with the connector.
`filter__activeStates`	`boolean`	No	Filters out connectors which are not in destroying or destroyed states
`filter__connectorIds`	`string[]`	No	Filter based on the connector IDs.
`filter__dataPlaneIds`	`string[]`	No	Filter based on the data plane in which the connector is deployed.
`filter__resourceTypes`	`string[]`	No	Filter based on the resource type that the connector supports.
`filter__connectorTypes`	`string[]`	No	Filter based on the connector type.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__names?: string,
    filter__search?: string,
    filter__states?: string,
    filter__resourceIds?: string,
    filter__activeStates?: boolean,
    filter__connectorIds?: string,
    filter__dataPlaneIds?: string,
    filter__resourceTypes?: string,
    filter__connectorTypes?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveConnectorById

connectors.retrieveConnectorById Retrieve connector by id Risk: read

await corsair.borneo.api.connectors.retrieveConnectorById({});

Input

Name	Type	Required	Description
`connectorId`	`string`	Yes	The unique Borneo connector ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Dashboard

createDashboardUser

dashboard.createDashboardUser Create dashboard user Risk: write

await corsair.borneo.api.dashboard.createDashboardUser({});

Input

Name	Type	Required	Description
`name`	`string`	No	Name
`email`	`string`	Yes	Email
`roles`	`borneo_admin \| borneo_analyst \| borneo_engineer \| compliance_engineer \| data_engineer \| department_coordinator \| no_access_role \| privacy_supervisor[]`	No	Roles
`filter__id`	`string`	No	Id
`filter__type`	`GCP \| OKTA`	No	Type
`organisations`	`object[]`	No	Organisations

organisations full type

{
  roles: borneo_admin | borneo_analyst | borneo_engineer | compliance_engineer | data_engineer | department_coordinator | no_access_role | privacy_supervisor[],
  departments?: string[],
  organisationId?: number
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    roles?: string,
    organisations?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteDashboardReportById

dashboard.deleteDashboardReportById Delete dashboard report by id Risk: destructive

await corsair.borneo.api.dashboard.deleteDashboardReportById({});

Input

Name	Type	Required	Description
`dashboardReportId`	`string`	Yes	Dashboardreportid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

disableDashboardUserByUsername

dashboard.disableDashboardUserByUsername Disable dashboard user by username Risk: write

await corsair.borneo.api.dashboard.disableDashboardUserByUsername({});

Input

Name	Type	Required	Description
`username`	`string`	Yes	Username

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

downloadDashboardReport

dashboard.downloadDashboardReport Download dashboard report Risk: read

await corsair.borneo.api.dashboard.downloadDashboardReport({});

Input

Name	Type	Required	Description
`reportType`	`DATA_DISCOVERY_DASHBOARD \| PRIVACY_OPS_DASHBOARD \| PRIVACY_OPS_DATA_FLOW`	Yes	Reporttype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    reportType?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

downloadDashboardReportEdition

dashboard.downloadDashboardReportEdition Download dashboard report edition Risk: read

await corsair.borneo.api.dashboard.downloadDashboardReportEdition({});

Input

Name	Type	Required	Description
`reportEditionId`	`string`	Yes	Reporteditionid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

enableDashboardUser

dashboard.enableDashboardUser Enable dashboard user Risk: write

await corsair.borneo.api.dashboard.enableDashboardUser({});

Input

Name	Type	Required	Description
`username`	`string`	Yes	Username

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

fetchDashboardReportById

dashboard.fetchDashboardReportById Fetch dashboard report by id Risk: read

await corsair.borneo.api.dashboard.fetchDashboardReportById({});

Input

Name	Type	Required	Description
`dashboardReportId`	`string`	Yes	Dashboardreportid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getDashboardReportEditionById

dashboard.getDashboardReportEditionById Get dashboard report edition by id Risk: read

await corsair.borneo.api.dashboard.getDashboardReportEditionById({});

Input

Name	Type	Required	Description
`reportEditionId`	`string`	Yes	Reporteditionid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDashboardReportEditions

dashboard.listDashboardReportEditions List dashboard report editions Risk: read

await corsair.borneo.api.dashboard.listDashboardReportEditions({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Nexttoken
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`dashboardReportId`	`string`	Yes	The `nextToken` from the last page of results to retrieve the next page of results.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    sort__column?: string,
    dashboardReportId?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDashboardReportsWithFilters

dashboard.listDashboardReportsWithFilters List dashboard reports with filters Risk: read

await corsair.borneo.api.dashboard.listDashboardReportsWithFilters({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`filter__type`	`DATA_DISCOVERY_DASHBOARD \| PRIVACY_OPS_DASHBOARD \| PRIVACY_OPS_DATA_FLOW[]`	No	Type
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the scan name.
`filter__frequency`	`/30 * * * \| 0 /1 * * \| 0 /12 * * \| 0 /4 * * \| 0 /6 * * \| 0 /8 * * \| 0 0 * * * \| 0 0 * * 0 \| 0 0 1 * * \| 0 0 1 1,4,7,10 * \| 0 0 1 1,7 *[]`	No	Frequency

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    filter__type?: string,
    sort__column?: string,
    filter__search?: string,
    filter__frequency?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDashboardUsersWithFilters

dashboard.listDashboardUsersWithFilters List dashboard users with filters Risk: read

await corsair.borneo.api.dashboard.listDashboardUsersWithFilters({});

Input

Name	Type	Required	Description
`filter__roles`	`borneo_admin \| borneo_analyst \| borneo_engineer \| compliance_engineer \| data_engineer \| department_coordinator \| no_access_role \| privacy_supervisor[]`	No	Roles
`filter__tenantId`	`string`	No	Tenantid
`filter__departments`	`string[]`	No	Departments
`filter__organisationId`	`number`	No	Organisationid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    filter__roles?: string,
    filter__departments?: string,
    filter__organisationId?: number,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postCurrentDashboardUser

dashboard.postCurrentDashboardUser Post current dashboard user Risk: read

await corsair.borneo.api.dashboard.postCurrentDashboardUser({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postDashboardReport

dashboard.postDashboardReport Post dashboard report Risk: write

await corsair.borneo.api.dashboard.postDashboardReport({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name
`roles`	`borneo_admin \| borneo_analyst \| borneo_engineer \| compliance_engineer \| data_engineer \| department_coordinator \| no_access_role \| privacy_supervisor[]`	No	Roles
`status`	`DELETED \| ONCE \| SCHEDULED`	Yes	Status
`createdBy`	`string`	No	Createdby
`frequency`	`/30 * * * \| 0 /1 * * \| 0 /12 * * \| 0 /4 * * \| 0 /6 * * \| 0 /8 * * \| 0 0 * * * \| 0 0 * * 0 \| 0 0 1 * * \| 0 0 1 1,4,7,10 * \| 0 0 1 1,7 *`	No	The 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.
`reportTypes`	`DATA_DISCOVERY_DASHBOARD \| PRIVACY_OPS_DASHBOARD \| PRIVACY_OPS_DATA_FLOW[]`	Yes	Reporttypes
`externalEmail`	`string[]`	No	Externalemail
`recipientsEmail`	`string[]`	No	Recipientsemail
`triggerImmediately`	`boolean`	Yes	Triggerimmediately

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    roles?: string,
    frequency?: string,
    reportTypes?: string,
    recipientsEmail?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

removeDashboardUserByUsername

dashboard.removeDashboardUserByUsername Remove dashboard user by username Risk: destructive

await corsair.borneo.api.dashboard.removeDashboardUserByUsername({});

Input

Name	Type	Required	Description
`username`	`string`	Yes	Username

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

resetDashboardUserPassword

dashboard.resetDashboardUserPassword Reset dashboard user password Risk: write

await corsair.borneo.api.dashboard.resetDashboardUserPassword({});

Input

Name	Type	Required	Description
`username`	`string`	Yes	Username

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

triggerDashboardReportByReportId

dashboard.triggerDashboardReportByReportId Trigger dashboard report by report id Risk: write

await corsair.borneo.api.dashboard.triggerDashboardReportByReportId({});

Input

Name	Type	Required	Description
`dashboardReportId`	`string`	Yes	Dashboardreportid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDashboardUserDetails

dashboard.updateDashboardUserDetails Update dashboard user details Risk: write

await corsair.borneo.api.dashboard.updateDashboardUserDetails({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name
`username`	`string`	Yes	Username

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDashboardUserRoles

dashboard.updateDashboardUserRoles Update dashboard user roles Risk: write

await corsair.borneo.api.dashboard.updateDashboardUserRoles({});

Input

Name	Type	Required	Description
`username`	`string`	Yes	Username
`organisations`	`object[]`	Yes	Organisations

organisations full type

{
  roles: borneo_admin | borneo_analyst | borneo_engineer | compliance_engineer | data_engineer | department_coordinator | no_access_role | privacy_supervisor[],
  departments?: string[],
  organisationId?: number
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    organisations?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Departments

createDepartmentWithTranslations

departments.createDepartmentWithTranslations Create department with translations Risk: write

await corsair.borneo.api.departments.createDepartmentWithTranslations({});

Input

Name	Type	Required	Description
`name`	`string`	No	Name
`translations`	`object`	No	Translations

translations full type

{
  additionalProperties?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    translations?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteDepartmentById

departments.deleteDepartmentById Delete department by id Risk: destructive

await corsair.borneo.api.departments.deleteDepartmentById({});

Input

Name	Type	Required	Description
`departmentId`	`string`	Yes	Identifier of the department.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getDepartmentFilterList

departments.getDepartmentFilterList Get department filter list Risk: read

await corsair.borneo.api.departments.getDepartmentFilterList({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDepartmentsWithSortAndPagination

departments.listDepartmentsWithSortAndPagination List departments with sort and pagination Risk: read

await corsair.borneo.api.departments.listDepartmentsWithSortAndPagination({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the department name.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDepartmentInformation

departments.retrieveDepartmentInformation Retrieve department information Risk: read

await corsair.borneo.api.departments.retrieveDepartmentInformation({});

Input

Name	Type	Required	Description
`departmentId`	`string`	Yes	Identifier of the department.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDepartmentName

departments.updateDepartmentName Update department name Risk: write

await corsair.borneo.api.departments.updateDepartmentName({});

Input

Name	Type	Required	Description
`name`	`string`	No	Name
`departmentId`	`string`	Yes	Identifier of the department.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Documents

createLegalDocumentEntry

documents.createLegalDocumentEntry Create legal document entry Risk: write

await corsair.borneo.api.documents.createLegalDocumentEntry({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name
`type`	`DATA_PROCESSING \| PRIVACY_POLICY`	No	Type
`region`	`string`	Yes	Region
`source`	`string`	No	Source
`documentLink`	`string`	Yes	Documentlink
`isDiscoverInfotype`	`boolean`	Yes	Isdiscoverinfotype
`fromDiscoveredDocumentId`	`string`	No	Fromdiscovereddocumentid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    type?: string,
    fromDiscoveredDocumentId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteLegalDocumentById

documents.deleteLegalDocumentById Delete legal document by id Risk: destructive

await corsair.borneo.api.documents.deleteLegalDocumentById({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	Documentid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDiscoveredDocument

documents.listDiscoveredDocument List discovered document Risk: read

await corsair.borneo.api.documents.listDiscoveredDocument({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the scan name.
`filter__status`	`ADDED \| DELETED \| DOMAIN_DELETED \| IGNORED \| NEW`	No	Status

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listLegalDocumentsWithPagination

documents.listLegalDocumentsWithPagination List legal documents with pagination Risk: read

await corsair.borneo.api.documents.listLegalDocumentsWithPagination({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the scan name.
`filter__status`	`CREATED \| DELETED \| SCANNING`	No	Status

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDiscoveredDocumentById

documents.retrieveDiscoveredDocumentById Retrieve discovered document by id Risk: read

await corsair.borneo.api.documents.retrieveDiscoveredDocumentById({});

Input

Name	Type	Required	Description
`discoveredDocumentId`	`string`	Yes	Discovereddocumentid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveLegalDocumentById

documents.retrieveLegalDocumentById Retrieve legal document by id Risk: read

await corsair.borneo.api.documents.retrieveLegalDocumentById({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	Documentid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDiscoveredDocumentStatus

documents.updateDiscoveredDocumentStatus Update discovered document status Risk: write

await corsair.borneo.api.documents.updateDiscoveredDocumentStatus({});

Input

Name	Type	Required	Description
`status`	`ADDED \| DELETED \| DOMAIN_DELETED \| IGNORED \| NEW`	Yes	Status
`discoveredDocumentId`	`string`	Yes	Discovereddocumentid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Domains

createDomainWithPollingFrequency

domains.createDomainWithPollingFrequency Create domain with polling frequency Risk: write

await corsair.borneo.api.domains.createDomainWithPollingFrequency({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name of the domain.
`frequency`	`12h \| 1d \| 1w \| 30d \| 6h \| manual`	Yes	Frequency of polling for a domain. Manual polling means that this domain will not be polled automatically.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    frequency?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteDomainById

domains.deleteDomainById Delete domain by id Risk: destructive

await corsair.borneo.api.domains.deleteDomainById({});

Input

Name	Type	Required	Description
`domainId`	`string`	Yes	Identifier of the domain.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getDomainById

domains.getDomainById Get domain by id Risk: read

await corsair.borneo.api.domains.getDomainById({});

Input

Name	Type	Required	Description
`domainId`	`string`	Yes	Identifier of the domain.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDomainsWithPaginationAndSorting

domains.listDomainsWithPaginationAndSorting List domains with pagination and sorting Risk: read

await corsair.borneo.api.domains.listDomainsWithPaginationAndSorting({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

pollDomainById

domains.pollDomainById Poll domain by id Risk: write

await corsair.borneo.api.domains.pollDomainById({});

Input

Name	Type	Required	Description
`domainId`	`string`	Yes	Identifier of the domain.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDomainDetails

domains.updateDomainDetails Update domain details Risk: write

await corsair.borneo.api.domains.updateDomainDetails({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name of the domain.
`domainId`	`string`	Yes	Identifier of the domain.
`frequency`	`12h \| 1d \| 1w \| 30d \| 6h \| manual`	Yes	Frequency of polling for a domain. Manual polling means that this domain will not be polled automatically.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    frequency?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Employees

createEmployeeWithJsonPayload

employees.createEmployeeWithJsonPayload Create employee with json payload Risk: write

await corsair.borneo.api.employees.createEmployeeWithJsonPayload({});

Input

Name	Type	Required	Description
`nif`	`string`	No	The NIF of the employee
`name`	`string`	Yes	The name of the employee
`email`	`string`	No	the email of the employee
`endDate`	`string`	No	Date when the employee end to work in your company
`manager`	`string`	No	employeeId of the employee who is manager of the employee
`surname`	`string`	Yes	The surname of the employee
`position`	`string`	No	The position of the employee in the company.
`createdBy`	`string`	Yes	Createdby
`startDate`	`string`	No	Date when the employee began to work in your company
`department`	`string`	No	the department of the employee
`referenceId`	`string`	No	Internal identifier to synchronize with external APIS

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    endDate?: string,
    manager?: string,
    position?: string,
    startDate?: string,
    department?: string,
    referenceId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteEmployeeById

employees.deleteEmployeeById Delete employee by id Risk: destructive

await corsair.borneo.api.employees.deleteEmployeeById({});

Input

Name	Type	Required	Description
`employeeId`	`string`	Yes	Identifier of the employee

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

filterEmployeeList

employees.filterEmployeeList Filter employee list Risk: read

await corsair.borneo.api.employees.filterEmployeeList({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the employee name.
`filter__department`	`string[]`	No	Department

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listEmployeesWithFilters

employees.listEmployeesWithFilters List employees with filters Risk: read

await corsair.borneo.api.employees.listEmployeesWithFilters({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the employee name.
`filter__department`	`string[]`	No	Department

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveEmployeeDetailsById

employees.retrieveEmployeeDetailsById Retrieve employee details by id Risk: read

await corsair.borneo.api.employees.retrieveEmployeeDetailsById({});

Input

Name	Type	Required	Description
`employeeId`	`string`	Yes	Identifier of the employee

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateEmployeeById

employees.updateEmployeeById Update employee by id Risk: write

await corsair.borneo.api.employees.updateEmployeeById({});

Input

Name	Type	Required	Description
`nif`	`string`	No	The NIF (Spanish Tax Identification Number) of the employee
`name`	`string`	No	The name of the employee
`email`	`string`	No	The email of the employee. Has to be unique within the company.
`endDate`	`string`	No	Date when the employee end to work in your company
`manager`	`string`	No	The employee”s direct manager.
`surname`	`string`	No	The surname of the employee
`position`	`string`	No	The position in the company of the employee
`startDate`	`string`	No	Date when the employee began to work in your company
`department`	`string`	No	The department of the employee
`employeeId`	`string`	Yes	Identifier of the employee

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nif?: string,
    email?: string,
    endDate?: string,
    position?: string,
    startDate?: string,
    department?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Headquarters

createHeadquarterEntry

headquarters.createHeadquarterEntry Create headquarter entry Risk: write

await corsair.borneo.api.headquarters.createHeadquarterEntry({});

Input

Name	Type	Required	Description
`city`	`string`	Yes	The locality of the headquarter
`name`	`string`	Yes	The name of the headquarter
`tomIds`	`string[]`	No	Tomids
`address`	`string`	Yes	The address of the headquarter
`country`	`string`	Yes	2 letter code that identifies a country.
`zipcode`	`string`	No	The zipcode of the headquarter

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteHeadquartersById

headquarters.deleteHeadquartersById Delete headquarters by id Risk: destructive

await corsair.borneo.api.headquarters.deleteHeadquartersById({});

Input

Name	Type	Required	Description
`headquarterId`	`string`	Yes	The identifier of the headquarter

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getHeadquartersById

headquarters.getHeadquartersById Get headquarters by id Risk: read

await corsair.borneo.api.headquarters.getHeadquartersById({});

Input

Name	Type	Required	Description
`headquarterId`	`string`	Yes	The identifier of the headquarter

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listHeadquartersWithSorting

headquarters.listHeadquartersWithSorting List headquarters with sorting Risk: read

await corsair.borneo.api.headquarters.listHeadquartersWithSorting({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateHeadquarterDetailsById

headquarters.updateHeadquarterDetailsById Update headquarter details by id Risk: write

await corsair.borneo.api.headquarters.updateHeadquarterDetailsById({});

Input

Name	Type	Required	Description
`city`	`string`	Yes	The locality of the headquarter
`name`	`string`	Yes	The name of the headquarter
`tomIds`	`string[]`	No	Tomids
`address`	`string`	Yes	The address of the headquarter
`country`	`string`	Yes	2 letter code that identifies a country.
`zipcode`	`string`	No	The zipcode of the headquarter
`headquarterId`	`string`	Yes	The identifier of the headquarter

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Infotypes

listDiscoveredInfotypes

infotypes.listDiscoveredInfotypes List discovered infotypes Risk: read

await corsair.borneo.api.infotypes.listDiscoveredInfotypes({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the scan name.
`filter__status`	`APPROVED \| APPROVED_AUTOMATICALLY \| DELETED \| IGNORED \| NEW \| NOT_PRESENT \| REQUESTED`	No	Status

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDiscoveredInfotypeById

infotypes.retrieveDiscoveredInfotypeById Retrieve discovered infotype by id Risk: read

await corsair.borneo.api.infotypes.retrieveDiscoveredInfotypeById({});

Input

Name	Type	Required	Description
`discoveredInfotypeId`	`string`	Yes	Discoveredinfotypeid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDiscoveredInfotypeStatus

infotypes.updateDiscoveredInfotypeStatus Update discovered infotype status Risk: write

await corsair.borneo.api.infotypes.updateDiscoveredInfotypeStatus({});

Input

Name	Type	Required	Description
`status`	`APPROVED \| APPROVED_AUTOMATICALLY \| DELETED \| IGNORED \| NEW \| NOT_PRESENT \| REQUESTED`	Yes	Status
`discoveredInfotypeId`	`string`	Yes	Discoveredinfotypeid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Misc

listFilteredSortedCategories

misc.listFilteredSortedCategories List filtered sorted categories Risk: read

await corsair.borneo.api.misc.listFilteredSortedCategories({});

Input

Name	Type	Required	Description
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__categories`	`string[]`	No	Categories

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    sort__column?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listIssuesWithFilters

misc.listIssuesWithFilters List issues with filters Risk: read

await corsair.borneo.api.misc.listIssuesWithFilters({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	List of column names to include in the response.
`include`	`object`	No	The set of related resources that should be included in the response using a join-query.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__states`	`string[]`	No	List of isssue states to filter by.
`filter__resources`	`string[]`	No	List of resource IDs to filter by.
`filter__severities`	`string[]`	No	List of issue severities to filter by.
`filter__resourceTypes`	`string[]`	No	List of resource types to filter by.
`filter__failedControls`	`string[]`	No	List of failed controls to filter by.
`filter__cloudAccountIds`	`string[]`	No	List of cloud provider account IDs to filter by.
`filter__cloudAccountTypes`	`string[]`	No	List of cloud provider account types to filter by.

include full type

{
  additionalProperties?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    select?: string,
    include?: boolean,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__states?: string,
    filter__resources?: string,
    filter__severities?: string,
    filter__resourceTypes?: string,
    filter__failedControls?: string,
    filter__cloudAccountIds?: string,
    filter__cloudAccountTypes?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveErrorDetailsById

misc.retrieveErrorDetailsById Retrieve error details by id Risk: read

await corsair.borneo.api.misc.retrieveErrorDetailsById({});

Input

Name	Type	Required	Description
`errorId`	`string`	Yes	The unique resource ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveIssueById

misc.retrieveIssueById Retrieve issue by id Risk: read

await corsair.borneo.api.misc.retrieveIssueById({});

Input

Name	Type	Required	Description
`issueId`	`string`	Yes	The unique issue ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

submitChatFeedback

misc.submitChatFeedback Submit chat feedback Risk: write

await corsair.borneo.api.misc.submitChatFeedback({});

Input

Name	Type	Required	Description
`postId`	`string`	No	Postid
`rating`	`number`	No	Rating

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Processing

createDpiaForProcessingActivity

processing.createDpiaForProcessingActivity Create dpia for processing activity Risk: write

await corsair.borneo.api.processing.createDpiaForProcessingActivity({});

Input

Name	Type	Required	Description
`status`	`activated \| draft`	Yes	The status of the DPIA. If a DPIA is saved as activated, several fields are required
`createdAt`	`number`	No	Createdat
`updatedAt`	`number`	No	Updatedat
`translations`	`object`	No	Translations
`integrity__impacts`	`object[]`	No	List of impacts that integrity risk can have. At least one element is necessary DPIA is saved as activated
`integrity__threats`	`object[]`	No	List of threats that integrity risk can have. At least one element is necessary DPIA is saved as activated
`processingActivityId`	`string`	Yes	Identifier of the processing activity for which we are creating a DPIA
`additionalInformation`	`string`	No	Additionalinformation
`availability__impacts`	`object[]`	No	List of impacts that availability risk can have. At least one element is necessary DPIA is saved as activated
`availability__threats`	`object[]`	No	List of threats that availability risk can have. At least one element is necessary DPIA is saved as activated
`integrity__plannedToms`	`string[]`	No	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__riskSources`	`object[]`	No	List of risk sources that integrity risk can have. At least one element is necessary DPIA is saved as activated
`confidentiality__impacts`	`object[]`	No	List of impacts that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
`confidentiality__threats`	`object[]`	No	List of threats that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
`availability__plannedToms`	`string[]`	No	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__riskSources`	`object[]`	No	List of risk sources that availability risk can have. At least one element is necessary DPIA is saved as activated
`integrity__impactsComment`	`string`	No	Comment to add additional information about the integrity impacts
`integrity__threatsComment`	`string`	No	Comment to add additional information about the integrity threats
`privacyFramework__consent`	`string`	No	Field 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
`additionalInformationFiles`	`string[]`	No	Additionalinformationfiles
`integrity__baselineComment`	`string`	No	Comment to add additional information about the baseline risk of the integrity
`integrity__implementedToms`	`string[]`	No	List of TOMs that are implemented to prevent integrity risk. At least one element is necessary DPIA is saved as activated
`privacyFramework__accuracy`	`string`	No	Field to explain if the data processed is accurate, high quality and up-to-date Mandatory if DPIA is saved as activated
`integrity__baselineSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`privacyFramework__retention`	`boolean`	No	Is the retention period lawful and clearly defined? Mandatory if DPIA is saved as activated
`availability__impactsComment`	`string`	No	Comment to add additional information about the impact
`availability__threatsComment`	`string`	No	Comment to add additional information about the threat
`confidentiality__plannedToms`	`string[]`	No	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__riskSources`	`object[]`	No	List of risk sources that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
`availability__baselineComment`	`string`	No	Comment to add additional information about the baseline risk of the availablity
`availability__implementedToms`	`string[]`	No	List of implemented TOMs that applies to the availability risk. At least one element is necessary DPIA is saved as activated
`integrity__baselineLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Baselinelikelihood
`integrity__plannedTomsComment`	`string`	No	Comment to add additional information about planned TOMs to prevent integrity risk
`integrity__riskSourcesComment`	`string`	No	Comment to add additional information about the integrity risk sources
`availability__baselineSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`integrity__residualRiskComment`	`string`	No	Comment to add additional information about the residual risk of the integrity
`privacyFramework__transparency`	`string`	No	Field 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__impactsComment`	`string`	No	Comment to add additional information about the confidentiality risk impacts
`confidentiality__threatsComment`	`string`	No	Comment to add additional information about the confidentiality risk threats
`integrity__residualRiskSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`availability__baselineLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Baselinelikelihood
`availability__plannedTomsComment`	`string`	No	Comment to add additional information about the planned TOMs
`availability__riskSourcesComment`	`string`	No	Comment to add additional information about the availability risk sources
`confidentiality__baselineComment`	`string`	No	Comment to add additional information about the baseline risk of the confidentiality
`confidentiality__implementedToms`	`string[]`	No	List of TOMs that are implemented to prevent confidentiality risk. At least one element is necessary DPIA is saved as activated
`availability__residualRiskComment`	`string`	No	Comment to add additional information about the residual risk of the availability
`confidentiality__baselineSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`integrity__implementedTomsComment`	`string`	No	Comment to add additional information about implemented TOMs to prevent integrity risk
`integrity__residualRiskLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Residualrisklikelihood
`availability__residualRiskSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`privacyFramework__dataMinimisation`	`string`	No	Field 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__retentionComment`	`string`	No	Field to add comment on the retention period
`confidentiality__baselineLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Baselinelikelihood
`confidentiality__plannedTomsComment`	`string`	No	Comment to add additional information about planned TOMs to prevent confidentiality risk
`confidentiality__riskSourcesComment`	`string`	No	Comment to add additional information about the confidentiality risk sources
`privacyFramework__additionalComment`	`string`	No	Field to add more information related to the privacy framework of the DPIA
`privacyFramework__purposeLimitation`	`string`	No	Field to explain the clear, specific and legitimate purpose of conducting the processing activity. Mandatory if DPIA is saved as activated
`availability__implementedTomsComment`	`string`	No	Comment to add additional information about the implemented TOMs
`availability__residualRiskLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Residualrisklikelihood
`confidentiality__residualRiskComment`	`string`	No	Comment to add additional information about the residual risk of the confidentiality
`confidentiality__residualRiskSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`privacyFramework__dataRightsExercised`	`string`	No	Field to describe how do data subjects exercise their data subject rights? Mandatory if DPIA is saved as activated
`confidentiality__implementedTomsComment`	`string`	No	Comment to add additional information about implemented TOMs to prevent confidentiality risk
`confidentiality__residualRiskLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Residualrisklikelihood

translations full type

{
  additionalProperties?: {
  }
}

integrity__impacts full type

{
  id: string,
  name?: string
}[]

integrity__threats full type

{
  id: string,
  name?: string
}[]

availability__impacts full type

{
  id: string,
  name?: string
}[]

availability__threats full type

{
  id: string,
  name?: string
}[]

integrity__riskSources full type

{
  id: string,
  name?: string
}[]

confidentiality__impacts full type

{
  id: string,
  name?: string
}[]

confidentiality__threats full type

{
  id: string,
  name?: string
}[]

availability__riskSources full type

{
  id: string,
  name?: string
}[]

confidentiality__riskSources full type

{
  id: string,
  name?: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    translations?: string,
    integrity__impacts?: string,
    integrity__threats?: string,
    processingActivityId?: string,
    additionalInformation?: string,
    availability__impacts?: string,
    availability__threats?: string,
    integrity__plannedToms?: string,
    integrity__riskSources?: string,
    confidentiality__impacts?: string,
    confidentiality__threats?: string,
    availability__plannedToms?: string,
    availability__riskSources?: string,
    integrity__impactsComment?: string,
    integrity__threatsComment?: string,
    privacyFramework__consent?: string,
    additionalInformationFiles?: string,
    integrity__baselineComment?: string,
    integrity__implementedToms?: string,
    privacyFramework__accuracy?: string,
    integrity__baselineSeverity?: string,
    privacyFramework__retention?: boolean,
    availability__impactsComment?: string,
    availability__threatsComment?: string,
    confidentiality__plannedToms?: string,
    confidentiality__riskSources?: string,
    availability__baselineComment?: string,
    availability__implementedToms?: string,
    integrity__baselineLikelihood?: string,
    integrity__plannedTomsComment?: string,
    integrity__riskSourcesComment?: string,
    availability__baselineSeverity?: string,
    integrity__residualRiskComment?: string,
    privacyFramework__transparency?: string,
    confidentiality__impactsComment?: string,
    confidentiality__threatsComment?: string,
    integrity__residualRiskSeverity?: string,
    availability__baselineLikelihood?: string,
    availability__plannedTomsComment?: string,
    availability__riskSourcesComment?: string,
    confidentiality__baselineComment?: string,
    confidentiality__implementedToms?: string,
    availability__residualRiskComment?: string,
    confidentiality__baselineSeverity?: string,
    integrity__implementedTomsComment?: string,
    integrity__residualRiskLikelihood?: string,
    availability__residualRiskSeverity?: string,
    privacyFramework__dataMinimisation?: string,
    privacyFramework__retentionComment?: string,
    confidentiality__baselineLikelihood?: string,
    confidentiality__plannedTomsComment?: string,
    confidentiality__riskSourcesComment?: string,
    privacyFramework__additionalComment?: string,
    privacyFramework__purposeLimitation?: string,
    availability__implementedTomsComment?: string,
    availability__residualRiskLikelihood?: string,
    confidentiality__residualRiskComment?: string,
    confidentiality__residualRiskSeverity?: string,
    privacyFramework__dataRightsExercised?: string,
    confidentiality__implementedTomsComment?: string,
    confidentiality__residualRiskLikelihood?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

createProcessingActivity

processing.createProcessingActivity Create processing activity Risk: write

await corsair.borneo.api.processing.createProcessingActivity({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name of the processing activity
`owner`	`string`	No	Owner
`active`	`boolean`	Yes	Flag to create the processing activity as activated or draft
`assets`	`string[]`	No	List assets ids related to the processing activity.
`modelId`	`string`	No	Modelid
`purpose`	`string`	No	Purpose
`language`	`ar \| de \| en \| es \| es-EC \| es-MX \| fr \| hi \| it \| ja \| pt \| zh`	No	Language
`createdAt`	`number`	No	Createdat
`dataTypes`	`string[]`	No	Datatypes
`infotypes`	`string[]`	No	List of info types related with the processing activity.
`updatedAt`	`number`	No	Updatedat
`recipients`	`object[]`	No	List of recipients related with the processing activity.
`companyRole`	`controller \| independent_controller \| joint_controller \| processor \| sub_processor[]`	No	Companyrole
`dataSources`	`string[]`	No	Datasources
`departments`	`string[]`	No	List departments related with the processing activity.
`lawfulBasis`	`object[]`	No	List of Lawfulness types affected by a processing activity
`dataSubjects`	`string[]`	No	List of Data Subjects affected by the processing activity
`isDataStored`	`boolean`	No	Indicates if you store the data.
`translations`	`object`	No	Translations
`contactPerson`	`string`	No	Contact person for the processing activity.
`additionalInfo`	`string`	No	Text to add more information about the processing activity
`infotypeVolume`	`0-1000 \| 1000-10000 \| 10000-100000 \| 100000+`	No	Ranges of the processed infotype volume.
`managementMethods`	`object[]`	No	Managementmethods
`infotypeCategories`	`string[]`	No	List of info types categories related with the processing activity.
`showOnRopaDocument`	`boolean`	No	Showonropadocument
`additionalInfoFiles`	`string[]`	No	List of uploaded file ids.
`processingFrequency`	`is_systematic \| not_systematic`	No	Data processing frequency.
`dataFlowRelationships`	`object[]`	No	Dataflowrelationships
`retentionPeriod__unit`	`day \| month \| week \| year`	No	Unit of time that is used for retention period
`retentionPeriodComment`	`string`	No	Retentionperiodcomment
`retentionPeriod__value`	`number`	No	Value
`areAccessRequestsManaged`	`boolean`	No	Indicates if the data subject access requests are managed.
`processingFrequencyComment`	`string`	No	Processingfrequencycomment
`processingActivitiesAsDataSources`	`string[]`	No	Processingactivitiesasdatasources

recipients full type

{
  role: controller | independent_controller | joint_controller | processor | sub_processor[],
  comment?: string,
  recipientId: string
}[]

lawfulBasis full type

{
  comment?: string,
  lawfulnessType: consent_person_concerned | contract | legal_obligation | legitimate_interest | public_interest | stakeholder_vital_interest
}[]

translations full type

{
  additionalProperties?: {
  }
}

managementMethods full type

{
  email?: string,
  methodType: email | postal,
  postalAddress__city?: string,
  postalAddress__street?: string,
  postalAddress__country?: string,
  postalAddress__zipcode?: string
}[]

dataFlowRelationships full type

{
  to__type?: MyOrganisation | dataSource | recipient | specificProcessingActivity,
  to__value?: string,
  from__type?: MyOrganisation | dataSource | recipient | specificProcessingActivity,
  from__value?: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    active?: boolean,
    assets?: string,
    language?: string,
    infotypes?: string,
    recipients?: string,
    companyRole?: string,
    departments?: string,
    lawfulBasis?: string,
    dataSubjects?: string,
    isDataStored?: boolean,
    translations?: string,
    contactPerson?: string,
    additionalInfo?: string,
    infotypeVolume?: string,
    managementMethods?: string,
    infotypeCategories?: string,
    additionalInfoFiles?: string,
    processingFrequency?: string,
    dataFlowRelationships?: string,
    retentionPeriod__unit?: string,
    retentionPeriodComment?: string,
    areAccessRequestsManaged?: boolean,
    processingFrequencyComment?: string,
    processingActivitiesAsDataSources?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

createProcessingActivityThreshold

processing.createProcessingActivityThreshold Create processing activity threshold Risk: write

await corsair.borneo.api.processing.createProcessingActivityThreshold({});

Input

Name	Type	Required	Description
`status`	`activated \| draft`	No	Status of the threshold. Can be draft or activated.
`comment`	`string`	No	Additional information related to the Threshold
`additionalComment`	`boolean`	No	Additionalcomment
`processingActivityId`	`string`	Yes	Identifier of the processing activity for which the threshold will be created
`largeScaleObservation`	`boolean`	No	Largescaleobservation
`sensitiveOrSpecialData`	`boolean`	No	Sensitiveorspecialdata
`rightsRiskProcessingData`	`boolean`	No	Rightsriskprocessingdata
`freedomRiskProcessingData`	`boolean`	No	Freedomriskprocessingdata
`innovativeTechnologiesUsed`	`boolean`	No	Innovativetechnologiesused
`processingPersonalDataRisk`	`boolean`	No	Processingpersonaldatarisk
`specialCategoryDataProcessed`	`boolean`	No	Specialcategorydataprocessed
`systematicPersonalAssessment`	`boolean`	No	Systematicpersonalassessment
`processingVulnerableDataSubject`	`boolean`	No	Processingvulnerabledatasubject

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    comment?: string,
    processingActivityId?: string,
    largeScaleObservation?: boolean,
    sensitiveOrSpecialData?: boolean,
    rightsRiskProcessingData?: boolean,
    freedomRiskProcessingData?: boolean,
    innovativeTechnologiesUsed?: boolean,
    processingPersonalDataRisk?: boolean,
    specialCategoryDataProcessed?: boolean,
    systematicPersonalAssessment?: boolean,
    processingVulnerableDataSubject?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

createThresholdForProcessingActivity

processing.createThresholdForProcessingActivity Create threshold for processing activity Risk: write

await corsair.borneo.api.processing.createThresholdForProcessingActivity({});

Input

Name	Type	Required	Description
`status`	`activated \| draft`	No	Status of the threshold. Can be draft or activated.
`comment`	`string`	No	Additional information related to the Threshold
`blacklist`	`boolean`	No	Indicates if the data processing is included in a black list
`createdAt`	`number`	No	Createdat
`updatedAt`	`number`	No	Updatedat
`translations`	`object`	No	Translations
`processingActivityId`	`string`	Yes	Identifier of the processing activity for which the threshold will be created
`classifyingDataSubject`	`boolean`	No	Indicates if this data processing is assessing or classifying data subjects
`automatedDecisionMaking`	`boolean`	No	Indicates if there is automated decision-making with legal effect, or similarly significant effect involved
`largeScaleDataProcessing`	`boolean`	No	Indicates if is a large scale data processing
`innovativeTechnologiesUsed`	`boolean`	No	Indicates if there are innovative technologies used
`matchingMergingRecordsInvolved`	`boolean`	No	Indicates if there is matching or merging of the records involved
`processingVulnerableDataSubject`	`boolean`	No	Indicates if there is processing of data of vulnerable data subjects
`systematicMonitoringDataSubject`	`boolean`	No	Indicates if there is systematic monitoring of data subjects involved
`largeScaleProcessingSensitiveData`	`boolean`	No	Indicates if the data processing is large scale processing of sensitive data.
`monitoringPubliclyAccessibleAreas`	`boolean`	No	Indicates if the data processing is systematic and large scale monitoring of publicly accessible areas involved.
`processingConfidentialSensitiveData`	`boolean`	No	Indicates if there is processing of confidential or sensitive data
`preventDataSubjectsExercisingTheirRights`	`boolean`	No	Indicates if the data processing prevents the data subjects from exercising their rights, using a service or performing a contract
`extensiveAutomatedEvaluationCharacteristics`	`boolean`	No	Indicates if the data processing involve any systematic, extensive and automated evaluation of personal characteristics with effect for the data subjects.

translations full type

{
  additionalProperties?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    comment?: string,
    blacklist?: boolean,
    translations?: string,
    processingActivityId?: string,
    classifyingDataSubject?: boolean,
    automatedDecisionMaking?: boolean,
    largeScaleDataProcessing?: boolean,
    innovativeTechnologiesUsed?: boolean,
    matchingMergingRecordsInvolved?: boolean,
    processingVulnerableDataSubject?: boolean,
    systematicMonitoringDataSubject?: boolean,
    largeScaleProcessingSensitiveData?: boolean,
    monitoringPubliclyAccessibleAreas?: boolean,
    processingConfidentialSensitiveData?: boolean,
    preventDataSubjectsExercisingTheirRights?: boolean,
    extensiveAutomatedEvaluationCharacteristics?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteDpiaById

processing.deleteDpiaById Delete dpia by id Risk: destructive

await corsair.borneo.api.processing.deleteDpiaById({});

Input

Name	Type	Required	Description
`dpiaId`	`string`	Yes	Identifier of the DPIA

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteLopdpThresholdById

processing.deleteLopdpThresholdById Delete lopdp threshold by id Risk: destructive

await corsair.borneo.api.processing.deleteLopdpThresholdById({});

Input

Name	Type	Required	Description
`lopdpThresholdId`	`string`	Yes	Identifier of the Threshold

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteProcessingActivityById

processing.deleteProcessingActivityById Delete processing activity by id Risk: destructive

await corsair.borneo.api.processing.deleteProcessingActivityById({});

Input

Name	Type	Required	Description
`processingActivityId`	`string`	Yes	Identifier of the Processing Activity

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    processingActivityId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteThresholdById

processing.deleteThresholdById Delete threshold by id Risk: destructive

await corsair.borneo.api.processing.deleteThresholdById({});

Input

Name	Type	Required	Description
`thresholdId`	`string`	Yes	Identifier of the Threshold

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

exportProcessingActivitiesList

processing.exportProcessingActivitiesList Export processing activities list Risk: read

await corsair.borneo.api.processing.exportProcessingActivitiesList({});

Input

Name	Type	Required	Description
`language`	`ar \| de \| en \| es \| es-EC \| es-MX \| fr \| hi \| it \| ja \| pt \| zh`	Yes	Language
`exportTypes`	`csv \| doc \| pdf[]`	Yes	Exporttypes
`filter__owners`	`string[]`	No	Owners
`filter__search`	`string`	No	Search
`filter__status`	`string[]`	No	Status
`filter__employees`	`string[]`	No	Employees
`filter__infotypes`	`string[]`	No	Infotypes
`filter__recipients`	`string[]`	No	Recipients
`filter__departments`	`string[]`	No	Departments
`filter__dataSubjects`	`string[]`	No	Datasubjects
`filter__processingActivityId`	`string`	No	Processingactivityid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    language?: string,
    exportTypes?: string,
    filter__departments?: string,
    filter__dataSubjects?: string,
    filter__processingActivityId?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getThresholdById

processing.getThresholdById Get threshold by id Risk: read

await corsair.borneo.api.processing.getThresholdById({});

Input

Name	Type	Required	Description
`thresholdId`	`string`	Yes	Identifier of the Threshold

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listProcessingActivities

processing.listProcessingActivities List processing activities Risk: read

await corsair.borneo.api.processing.listProcessingActivities({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__assets`	`string[]`	No	Assets
`filter__owners`	`string[]`	No	Owners
`filter__search`	`string`	No	Free-form text search to apply to processing activity name.
`filter__status`	`string[]`	No	Status
`filter__dataTypes`	`string[]`	No	Datatypes
`filter__employees`	`string[]`	No	Employees
`filter__infotypes`	`string[]`	No	Infotypes
`filter__languages`	`string[]`	No	Languages
`filter__recipients`	`string[]`	No	Recipients
`filter__dataSources`	`string[]`	No	Datasources
`filter__departments`	`string[]`	No	Departments
`filter__companyRoles`	`string[]`	No	Companyroles
`filter__dataSubjects`	`string[]`	No	Datasubjects
`filter__paAsDataSource`	`string[]`	No	Paasdatasource
`filter__infotypeCategories`	`string[]`	No	Infotypecategories

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__dataSources?: string,
    filter__departments?: string,
    filter__companyRoles?: string,
    filter__dataSubjects?: string,
    filter__paAsDataSource?: string,
    filter__infotypeCategories?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listProcessingActivitiesFilters

processing.listProcessingActivitiesFilters List processing activities filters Risk: read

await corsair.borneo.api.processing.listProcessingActivitiesFilters({});

Input

Name	Type	Required	Description
`filterType`	`asset \| companyRole \| dataSubject \| department \| employee \| owner \| recipient \| status`	Yes	Type of filter to retrieve options for

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    filterType?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listTomsWithFilterAndPaginationOptions

processing.listTomsWithFilterAndPaginationOptions List toms with filter and pagination options Risk: read

await corsair.borneo.api.processing.listTomsWithFilterAndPaginationOptions({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`filter__list`	`string[]`	No	List
`filter__type`	`string[]`	No	Type
`sort__column`	`string`	No	The column name to sort on.
`filter__tomId`	`string[]`	No	Tomid
`filter__search`	`string`	No	Free-form text search to apply to the toms name.
`filter__status`	`string[]`	No	Status
`filter__category`	`string[]`	No	Category
`filter__objectCategory`	`string[]`	No	Objectcategory

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__objectCategory?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

putTomStatusAndNote

processing.putTomStatusAndNote Put tom status and note Risk: write

await corsair.borneo.api.processing.putTomStatusAndNote({});

Input

Name	Type	Required	Description
`note`	`string`	No	Note
`tomId`	`string`	Yes	Tomid
`status`	`available \| implemented \| pendingToImplement`	Yes	Status of the TOM, i.e. whether the TOM is already implemented, implementation is pending, or the TOM is not implemented.
`documentFiles`	`string[]`	No	Uploaded file id list.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    documentFiles?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDpiaById

processing.retrieveDpiaById Retrieve dpia by id Risk: read

await corsair.borneo.api.processing.retrieveDpiaById({});

Input

Name	Type	Required	Description
`dpiaId`	`string`	Yes	Identifier of the DPIA

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveLopdpThresholdById

processing.retrieveLopdpThresholdById Retrieve lopdp threshold by id Risk: read

await corsair.borneo.api.processing.retrieveLopdpThresholdById({});

Input

Name	Type	Required	Description
`lopdpThresholdId`	`string`	Yes	Identifier of the Threshold

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveProcessingActivityById

processing.retrieveProcessingActivityById Retrieve processing activity by id Risk: read

await corsair.borneo.api.processing.retrieveProcessingActivityById({});

Input

Name	Type	Required	Description
`processingActivityId`	`string`	Yes	Identifier of the Processing Activity

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    processingActivityId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveTomById

processing.retrieveTomById Retrieve tom by id Risk: read

await corsair.borneo.api.processing.retrieveTomById({});

Input

Name	Type	Required	Description
`tomId`	`string`	Yes	Identifier of the TOM

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDpiaById

processing.updateDpiaById Update dpia by id Risk: write

await corsair.borneo.api.processing.updateDpiaById({});

Input

Name	Type	Required	Description
`dpiaId`	`string`	Yes	Identifier of the DPIA
`status`	`activated \| draft`	Yes	The status of the DPIA. If a DPIA is saved as activated, several fields are required
`translations`	`object`	No	Translations
`integrity__impacts`	`object[]`	No	List of impacts that integrity risk can have. At least one element is necessary DPIA is saved as activated
`integrity__threats`	`object[]`	No	List of threats that integrity risk can have. At least one element is necessary DPIA is saved as activated
`additionalInformation`	`string`	No	Additionalinformation
`availability__impacts`	`object[]`	No	List of impacts that availability risk can have. At least one element is necessary DPIA is saved as activated
`availability__threats`	`object[]`	No	List of threats that availability risk can have. At least one element is necessary DPIA is saved as activated
`integrity__plannedToms`	`string[]`	No	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__riskSources`	`object[]`	No	List of risk sources that integrity risk can have. At least one element is necessary DPIA is saved as activated
`confidentiality__impacts`	`object[]`	No	List of impacts that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
`confidentiality__threats`	`object[]`	No	List of threats that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
`availability__plannedToms`	`string[]`	No	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__riskSources`	`object[]`	No	List of risk sources that availability risk can have. At least one element is necessary DPIA is saved as activated
`integrity__impactsComment`	`string`	No	Comment to add additional information about the integrity impacts
`integrity__threatsComment`	`string`	No	Comment to add additional information about the integrity threats
`privacyFramework__consent`	`string`	No	Field 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
`additionalInformationFiles`	`string[]`	No	Additionalinformationfiles
`integrity__baselineComment`	`string`	No	Comment to add additional information about the baseline risk of the integrity
`integrity__implementedToms`	`string[]`	No	List of TOMs that are implemented to prevent integrity risk. At least one element is necessary DPIA is saved as activated
`privacyFramework__accuracy`	`string`	No	Field to explain if the data processed is accurate, high quality and up-to-date Mandatory if DPIA is saved as activated
`integrity__baselineSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`privacyFramework__retention`	`boolean`	No	Is the retention period lawful and clearly defined? Mandatory if DPIA is saved as activated
`availability__impactsComment`	`string`	No	Comment to add additional information about the impact
`availability__threatsComment`	`string`	No	Comment to add additional information about the threat
`confidentiality__plannedToms`	`string[]`	No	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__riskSources`	`object[]`	No	List of risk sources that confidentiality risk can have. At least one element is necessary DPIA is saved as activated
`availability__baselineComment`	`string`	No	Comment to add additional information about the baseline risk of the availablity
`availability__implementedToms`	`string[]`	No	List of implemented TOMs that applies to the availability risk. At least one element is necessary DPIA is saved as activated
`integrity__baselineLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Baselinelikelihood
`integrity__plannedTomsComment`	`string`	No	Comment to add additional information about planned TOMs to prevent integrity risk
`integrity__riskSourcesComment`	`string`	No	Comment to add additional information about the integrity risk sources
`availability__baselineSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`integrity__residualRiskComment`	`string`	No	Comment to add additional information about the residual risk of the integrity
`privacyFramework__transparency`	`string`	No	Field 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__impactsComment`	`string`	No	Comment to add additional information about the confidentiality risk impacts
`confidentiality__threatsComment`	`string`	No	Comment to add additional information about the confidentiality risk threats
`integrity__residualRiskSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`availability__baselineLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Baselinelikelihood
`availability__plannedTomsComment`	`string`	No	Comment to add additional information about the planned TOMs
`availability__riskSourcesComment`	`string`	No	Comment to add additional information about the availability risk sources
`confidentiality__baselineComment`	`string`	No	Comment to add additional information about the baseline risk of the confidentiality
`confidentiality__implementedToms`	`string[]`	No	List of TOMs that are implemented to prevent confidentiality risk. At least one element is necessary DPIA is saved as activated
`availability__residualRiskComment`	`string`	No	Comment to add additional information about the residual risk of the availability
`confidentiality__baselineSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`integrity__implementedTomsComment`	`string`	No	Comment to add additional information about implemented TOMs to prevent integrity risk
`integrity__residualRiskLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Residualrisklikelihood
`availability__residualRiskSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`privacyFramework__dataMinimisation`	`string`	No	Field 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__retentionComment`	`string`	No	Field to add comment on the retention period
`confidentiality__baselineLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Baselinelikelihood
`confidentiality__plannedTomsComment`	`string`	No	Comment to add additional information about planned TOMs to prevent confidentiality risk
`confidentiality__riskSourcesComment`	`string`	No	Comment to add additional information about the confidentiality risk sources
`privacyFramework__additionalComment`	`string`	No	Field to add more information related to the privacy framework of the DPIA
`privacyFramework__purposeLimitation`	`string`	No	Field to explain the clear, specific and legitimate purpose of conducting the processing activity. Mandatory if DPIA is saved as activated
`availability__implementedTomsComment`	`string`	No	Comment to add additional information about the implemented TOMs
`availability__residualRiskLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Residualrisklikelihood
`confidentiality__residualRiskComment`	`string`	No	Comment to add additional information about the residual risk of the confidentiality
`confidentiality__residualRiskSeverity`	`high \| low \| medium \| very_high \| very_low`	No	Represents the severity of a risk
`privacyFramework__dataRightsExercised`	`string`	No	Field to describe how do data subjects exercise their data subject rights? Mandatory if DPIA is saved as activated
`confidentiality__implementedTomsComment`	`string`	No	Comment to add additional information about implemented TOMs to prevent confidentiality risk
`confidentiality__residualRiskLikelihood`	`likely \| limited \| maximum \| negligible \| unlikely`	No	Residualrisklikelihood

translations full type

{
  additionalProperties?: {
  }
}

integrity__impacts full type

{
  id: string,
  name?: string
}[]

integrity__threats full type

{
  id: string,
  name?: string
}[]

availability__impacts full type

{
  id: string,
  name?: string
}[]

availability__threats full type

{
  id: string,
  name?: string
}[]

integrity__riskSources full type

{
  id: string,
  name?: string
}[]

confidentiality__impacts full type

{
  id: string,
  name?: string
}[]

confidentiality__threats full type

{
  id: string,
  name?: string
}[]

availability__riskSources full type

{
  id: string,
  name?: string
}[]

confidentiality__riskSources full type

{
  id: string,
  name?: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    translations?: string,
    integrity__impacts?: string,
    integrity__threats?: string,
    additionalInformation?: string,
    availability__impacts?: string,
    availability__threats?: string,
    integrity__plannedToms?: string,
    integrity__riskSources?: string,
    confidentiality__impacts?: string,
    confidentiality__threats?: string,
    availability__plannedToms?: string,
    availability__riskSources?: string,
    integrity__impactsComment?: string,
    integrity__threatsComment?: string,
    privacyFramework__consent?: string,
    additionalInformationFiles?: string,
    integrity__baselineComment?: string,
    integrity__implementedToms?: string,
    privacyFramework__accuracy?: string,
    integrity__baselineSeverity?: string,
    privacyFramework__retention?: boolean,
    availability__impactsComment?: string,
    availability__threatsComment?: string,
    confidentiality__plannedToms?: string,
    confidentiality__riskSources?: string,
    availability__baselineComment?: string,
    availability__implementedToms?: string,
    integrity__baselineLikelihood?: string,
    integrity__plannedTomsComment?: string,
    integrity__riskSourcesComment?: string,
    availability__baselineSeverity?: string,
    integrity__residualRiskComment?: string,
    privacyFramework__transparency?: string,
    confidentiality__impactsComment?: string,
    confidentiality__threatsComment?: string,
    integrity__residualRiskSeverity?: string,
    availability__baselineLikelihood?: string,
    availability__plannedTomsComment?: string,
    availability__riskSourcesComment?: string,
    confidentiality__baselineComment?: string,
    confidentiality__implementedToms?: string,
    availability__residualRiskComment?: string,
    confidentiality__baselineSeverity?: string,
    integrity__implementedTomsComment?: string,
    integrity__residualRiskLikelihood?: string,
    availability__residualRiskSeverity?: string,
    privacyFramework__dataMinimisation?: string,
    privacyFramework__retentionComment?: string,
    confidentiality__baselineLikelihood?: string,
    confidentiality__plannedTomsComment?: string,
    confidentiality__riskSourcesComment?: string,
    privacyFramework__additionalComment?: string,
    privacyFramework__purposeLimitation?: string,
    availability__implementedTomsComment?: string,
    availability__residualRiskLikelihood?: string,
    confidentiality__residualRiskComment?: string,
    confidentiality__residualRiskSeverity?: string,
    privacyFramework__dataRightsExercised?: string,
    confidentiality__implementedTomsComment?: string,
    confidentiality__residualRiskLikelihood?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateLopdpThresholdById

processing.updateLopdpThresholdById Update lopdp threshold by id Risk: write

await corsair.borneo.api.processing.updateLopdpThresholdById({});

Input

Name	Type	Required	Description
`status`	`activated \| draft`	No	Status of the threshold. Can be draft or activated.
`comment`	`string`	No	Additional information related to the Threshold
`lopdpThresholdId`	`string`	Yes	Identifier of the Threshold
`additionalComment`	`boolean`	No	Additionalcomment
`largeScaleObservation`	`boolean`	No	Largescaleobservation
`sensitiveOrSpecialData`	`boolean`	No	Sensitiveorspecialdata
`rightsRiskProcessingData`	`boolean`	No	Rightsriskprocessingdata
`freedomRiskProcessingData`	`boolean`	No	Freedomriskprocessingdata
`innovativeTechnologiesUsed`	`boolean`	No	Innovativetechnologiesused
`processingPersonalDataRisk`	`boolean`	No	Processingpersonaldatarisk
`specialCategoryDataProcessed`	`boolean`	No	Specialcategorydataprocessed
`systematicPersonalAssessment`	`boolean`	No	Systematicpersonalassessment
`processingVulnerableDataSubject`	`boolean`	No	Processingvulnerabledatasubject

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    comment?: string,
    largeScaleObservation?: boolean,
    sensitiveOrSpecialData?: boolean,
    rightsRiskProcessingData?: boolean,
    freedomRiskProcessingData?: boolean,
    innovativeTechnologiesUsed?: boolean,
    processingPersonalDataRisk?: boolean,
    specialCategoryDataProcessed?: boolean,
    systematicPersonalAssessment?: boolean,
    processingVulnerableDataSubject?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateProcessingActivityDetails

processing.updateProcessingActivityDetails Update processing activity details Risk: write

await corsair.borneo.api.processing.updateProcessingActivityDetails({});

Input

Name	Type	Required	Description
`name`	`string`	Yes	Name of the processing activity
`owner`	`string`	No	Owner
`active`	`boolean`	Yes	Flag to create the processing activity as activated or draft
`assets`	`string[]`	No	List assets ids related to the processing activity.
`modelId`	`string`	No	Modelid
`purpose`	`string`	No	Purpose of the processing activity
`dataTypes`	`string[]`	No	Datatypes
`infotypes`	`string[]`	No	List of info types related with the processing activity.
`recipients`	`object[]`	No	List of recipients related with the processing activity.
`companyRole`	`controller \| independent_controller \| joint_controller \| processor \| sub_processor[]`	No	Companyrole
`dataSources`	`string[]`	No	Datasources
`departments`	`string[]`	No	List departments related with the processing activity.
`lawfulBasis`	`object[]`	No	List of Lawfulness types affected by a processing activity
`dataSubjects`	`string[]`	No	List of Data Subjects affected by the processing activity
`isDataStored`	`boolean`	No	Indicates if you store the data.
`translations`	`object`	No	Translations
`contactPerson`	`string`	No	Contact person for the processing activity.
`additionalInfo`	`string`	No	Text to add more information about the processing activity
`infotypeVolume`	`0-1000 \| 1000-10000 \| 10000-100000 \| 100000+`	No	Ranges of the processed infotype volume.
`managementMethods`	`object[]`	No	Managementmethods
`infotypeCategories`	`string[]`	No	List of info types categories related with the processing activity.
`showOnRopaDocument`	`boolean`	No	Showonropadocument
`additionalInfoFiles`	`string[]`	No	List of uploaded file ids.
`processingFrequency`	`is_systematic \| not_systematic`	No	Data processing frequency.
`processingActivityId`	`string`	Yes	Identifier of the Processing Activity
`dataFlowRelationships`	`object[]`	No	Dataflowrelationships
`retentionPeriod__unit`	`day \| month \| week \| year`	No	Unit of time that is used for retention period
`retentionPeriodComment`	`string`	No	Additional information related to the retention period
`retentionPeriod__value`	`number`	No	Value
`areAccessRequestsManaged`	`boolean`	No	Indicates if the data subject access requests are managed.
`processingFrequencyComment`	`string`	No	Processingfrequencycomment
`processingActivitiesAsDataSources`	`string[]`	No	Processingactivitiesasdatasources

recipients full type

{
  role: controller | independent_controller | joint_controller | processor | sub_processor[],
  comment?: string,
  recipientId: string
}[]

lawfulBasis full type

{
  comment?: string,
  lawfulnessType: consent_person_concerned | contract | legal_obligation | legitimate_interest | public_interest | stakeholder_vital_interest
}[]

translations full type

{
  additionalProperties?: {
  }
}

managementMethods full type

{
  email?: string,
  methodType: email | postal,
  postalAddress__city?: string,
  postalAddress__street?: string,
  postalAddress__country?: string,
  postalAddress__zipcode?: string
}[]

dataFlowRelationships full type

{
  to__type?: MyOrganisation | dataSource | recipient | specificProcessingActivity,
  to__value?: string,
  from__type?: MyOrganisation | dataSource | recipient | specificProcessingActivity,
  from__value?: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    active?: boolean,
    assets?: string,
    purpose?: string,
    infotypes?: string,
    recipients?: string,
    companyRole?: string,
    departments?: string,
    lawfulBasis?: string,
    dataSubjects?: string,
    isDataStored?: boolean,
    translations?: string,
    contactPerson?: string,
    additionalInfo?: string,
    infotypeVolume?: string,
    managementMethods?: string,
    infotypeCategories?: string,
    additionalInfoFiles?: string,
    processingFrequency?: string,
    processingActivityId?: string,
    dataFlowRelationships?: string,
    retentionPeriod__unit?: string,
    retentionPeriodComment?: string,
    areAccessRequestsManaged?: boolean,
    processingFrequencyComment?: string,
    processingActivitiesAsDataSources?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateThresholdById

processing.updateThresholdById Update threshold by id Risk: write

await corsair.borneo.api.processing.updateThresholdById({});

Input

Name	Type	Required	Description
`status`	`activated \| draft`	No	Status of the threshold. Can be draft or activated.
`comment`	`string`	No	Additional information related to the Threshold
`blacklist`	`boolean`	No	Indicates if the data processing is included in a black list
`thresholdId`	`string`	Yes	Identifier of the Threshold
`translations`	`object`	No	Translations
`classifyingDataSubject`	`boolean`	No	Indicates if this data processing is assessing or classifying data subjects
`automatedDecisionMaking`	`boolean`	No	Indicates if there is automated decision-making with legal effect, or similarly significant effect involved
`largeScaleDataProcessing`	`boolean`	No	Indicates if is a large scale data processing
`innovativeTechnologiesUsed`	`boolean`	No	Indicates if there are innovative technologies used
`matchingMergingRecordsInvolved`	`boolean`	No	Indicates if there is matching or merging of the records involved
`processingVulnerableDataSubject`	`boolean`	No	Indicates if there is processing of data of vulnerable data subjects
`systematicMonitoringDataSubject`	`boolean`	No	Indicates if there is systematic monitoring of data subjects involved
`largeScaleProcessingSensitiveData`	`boolean`	No	Indicates if the data processing is large scale processing of sensitive data.
`monitoringPubliclyAccessibleAreas`	`boolean`	No	Indicates if the data processing is systematic and large scale monitoring of publicly accessible areas involved.
`processingConfidentialSensitiveData`	`boolean`	No	Indicates if there is processing of confidential or sensitive data
`preventDataSubjectsExercisingTheirRights`	`boolean`	No	Indicates if the data processing prevents the data subjects from exercising their rights, using a service or performing a contract
`extensiveAutomatedEvaluationCharacteristics`	`boolean`	No	Indicates if the data processing involve any systematic, extensive and automated evaluation of personal characteristics with effect for the data subjects.

translations full type

{
  additionalProperties?: {
  }
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    comment?: string,
    blacklist?: boolean,
    translations?: string,
    classifyingDataSubject?: boolean,
    automatedDecisionMaking?: boolean,
    largeScaleDataProcessing?: boolean,
    innovativeTechnologiesUsed?: boolean,
    matchingMergingRecordsInvolved?: boolean,
    processingVulnerableDataSubject?: boolean,
    systematicMonitoringDataSubject?: boolean,
    largeScaleProcessingSensitiveData?: boolean,
    monitoringPubliclyAccessibleAreas?: boolean,
    processingConfidentialSensitiveData?: boolean,
    preventDataSubjectsExercisingTheirRights?: boolean,
    extensiveAutomatedEvaluationCharacteristics?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Recipients

addDiscoveredRecipients

recipients.addDiscoveredRecipients Add discovered recipients Risk: write

await corsair.borneo.api.recipients.addDiscoveredRecipients({});

Input

Name	Type	Required	Description
`discoveredRecipientIds`	`string[]`	Yes	Identifiers of the discovered recipients to add as recipients.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    discoveredRecipientIds?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

archiveDiscoveredRecipient

recipients.archiveDiscoveredRecipient Archive discovered recipient Risk: destructive

await corsair.borneo.api.recipients.archiveDiscoveredRecipient({});

Input

Name	Type	Required	Description
`discoveredRecipientId`	`string`	Yes	Identifier of the discovered recipient.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    discoveredRecipientId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

createRecipientWithDetails

recipients.createRecipientWithDetails Create recipient with details Risk: write

await corsair.borneo.api.recipients.createRecipientWithDetails({});

Input

Name	Type	Required	Description
`dpa`	`string`	No	The url to the DPA of the recipient
`name`	`string`	Yes	Name of the recipient. Has to be unique, 2 different recipients can”t have the same name.
`role`	`controller \| independent_controller \| joint_controller \| processor \| sub_processor[]`	No	Role
`state`	`AK \| AL \| AR \| AZ \| CA \| CO \| CT \| DC \| DE \| FL \| GA \| HI \| IA \| ID \| IL \| IN \| KS \| KY \| LA \| MA \| MD \| ME \| MI \| MN \| MO \| MS \| MT \| NC \| ND \| NE \| NH \| NJ \| NM \| NV \| NY \| OH \| OK \| OR \| PA \| RI \| SC \| SD \| TN \| TX \| UT \| VA \| VT \| WA \| WI \| WV \| WY`	No	2 letter code that identifies the state of the recipient. It only applies when the recipient country is US
`status`	`archived \| validated`	Yes	The status of the recipient. Can be archived or validated.
`country`	`string`	No	2 letter code that identifies a country.
`dpaFiles`	`string[]`	No	List of uploaded file ids.
`createdAt`	`number`	No	Createdat
`dpaStatus`	`attached \| notRequired \| requested`	No	The 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.
`updatedAt`	`number`	No	Updatedat
`categories`	ITInfrastructure \| accountingSoftware \| adminDepartment \| advertising \| airlines \| analytics \| apps \| artificialIntelligenceAi \| assetManagement \| audit \| automotive \| b2b \| bankCards \| bigData \| businessDevelopment \| businessIntelligence \| businessManagement \| chat \| cloudComputing \| cloudDataServices \| cloudManagement \| cloudSecurity \| cloudStorage \| communities \| compliance \| construction \| consulting \| consumerElectronics \| content \| coreBankingSystem \| crmSoftware \| cryptoCurrency \| customerServiceProvider \| customerSupport \| cyberSecurity \| dataIntegration \| dataManagement \| dataStorage \| dataVisualization \| database \| developerTools \| devops \| digitalMedia \| documentManagement \| e-learning \| eCommerce \| edtech \| education \| electronics \| emailMarketing \| emailServices \| energy \| enterprise \| enterpriseSoftware \| erpSoftware \| events \| eventsSoftware \| fileSharing \| financialCrime \| financialServices \| fintech \| fitness \| foodAndBeverage \| government \| healthCare \| hospitality \| hosting \| identityManagement \| informationTechnology \| insurance \| insurtech \| internalDepartment \| internetOfThings \| itDepartment \| lawEnforcement \| lawServices \| legalDepartment \| logistics \| machineLearning \| management \| marketResearch \| marketingAutomation \| marketingDepartment \| marketingSoftware \| marketingTools \| marketplace \| medical \| messagingServices \| mobileApps \| mobilityEquipment \| networkSecurity \| news \| nonProfit \| officeApplications \| officesApps \| onlinePortals \| orderingSoftware \| other \| outsourcing \| passwordManagement \| paymentPlatform \| payrollServices \| pharmaceuticals \| physicalSecurity \| physicalStorage \| prDepartment \| preventionRisks \| productionDepartment \| productivityTools \| professionalServices \| projectManagement \| propertyAdministration \| publicAdministration \| publishing \| realEstate \| regulatoryReporting \| retail \| riskManagement \| rrhhDepartment \| rrhhManagement \| rrhhSoftware \| saas \| searchEngine \| security \| securityServices \| sellDepartment \| servicesPlatform \| smallAndMediumBusinesses \| socialMedia \| supplyChainManagement \| taxManagement \| telecommunications \| ticServices \| tourism \| tracking \| trading \| training \| transportation \| travel \| ventureCapital \| video \| videoStreaming \| voip \| webDesign \| wellness[]	No	list of recipient category
`businessName`	`string`	No	Business name of the recipient
`recipientState`	`active \| assessment`	No	Recipientstate
`subProcessorIds`	`string[]`	No	Subprocessorids
`recipientModelId`	`string`	No	Identifier of the Recipient Model in case that the Recipient is created bases in a Recipient Model
`dataStorageLocation`	`string[]`	Yes	List of countries where the data related to this recipient are stored
`recipientWarranties`	`string[]`	Yes	List of lawful basis types that applies to the recipient.
`fromDiscoveredRecipientId`	`string`	No	Fromdiscoveredrecipientid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    dpa?: string,
    name?: string,
    role?: string,
    state?: string,
    status?: string,
    country?: string,
    dpaFiles?: string,
    dpaStatus?: string,
    categories?: string,
    businessName?: string,
    recipientState?: string,
    subProcessorIds?: string,
    recipientModelId?: string,
    dataStorageLocation?: string,
    recipientWarranties?: string,
    fromDiscoveredRecipientId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

deleteRecipientById

recipients.deleteRecipientById Delete recipient by id Risk: destructive

await corsair.borneo.api.recipients.deleteRecipientById({});

Input

Name	Type	Required	Description
`recipientId`	`string`	Yes	Identifier of the Recipient

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

exportRecipientsListWithFilter

recipients.exportRecipientsListWithFilter Export recipients list with filter Risk: read

await corsair.borneo.api.recipients.exportRecipientsListWithFilter({});

Input

Name	Type	Required	Description
`exportTypes`	`csv \| doc \| pdf[]`	Yes	Exporttypes
`filter__role`	`string[]`	No	Role
`filter__search`	`string`	No	Free-form text search to apply to the Recipient name.
`filter__status`	`archived \| validated`	No	The status of the recipient. Can be archived or validated.
`filter__usedIn`	`object`	No	Usedin
`filter__categories`	ITInfrastructure \| accountingSoftware \| adminDepartment \| advertising \| airlines \| analytics \| apps \| artificialIntelligenceAi \| assetManagement \| audit \| automotive \| b2b \| bankCards \| bigData \| businessDevelopment \| businessIntelligence \| businessManagement \| chat \| cloudComputing \| cloudDataServices \| cloudManagement \| cloudSecurity \| cloudStorage \| communities \| compliance \| construction \| consulting \| consumerElectronics \| content \| coreBankingSystem \| crmSoftware \| cryptoCurrency \| customerServiceProvider \| customerSupport \| cyberSecurity \| dataIntegration \| dataManagement \| dataStorage \| dataVisualization \| database \| developerTools \| devops \| digitalMedia \| documentManagement \| e-learning \| eCommerce \| edtech \| education \| electronics \| emailMarketing \| emailServices \| energy \| enterprise \| enterpriseSoftware \| erpSoftware \| events \| eventsSoftware \| fileSharing \| financialCrime \| financialServices \| fintech \| fitness \| foodAndBeverage \| government \| healthCare \| hospitality \| hosting \| identityManagement \| informationTechnology \| insurance \| insurtech \| internalDepartment \| internetOfThings \| itDepartment \| lawEnforcement \| lawServices \| legalDepartment \| logistics \| machineLearning \| management \| marketResearch \| marketingAutomation \| marketingDepartment \| marketingSoftware \| marketingTools \| marketplace \| medical \| messagingServices \| mobileApps \| mobilityEquipment \| networkSecurity \| news \| nonProfit \| officeApplications \| officesApps \| onlinePortals \| orderingSoftware \| other \| outsourcing \| passwordManagement \| paymentPlatform \| payrollServices \| pharmaceuticals \| physicalSecurity \| physicalStorage \| prDepartment \| preventionRisks \| productionDepartment \| productivityTools \| professionalServices \| projectManagement \| propertyAdministration \| publicAdministration \| publishing \| realEstate \| regulatoryReporting \| retail \| riskManagement \| rrhhDepartment \| rrhhManagement \| rrhhSoftware \| saas \| searchEngine \| security \| securityServices \| sellDepartment \| servicesPlatform \| smallAndMediumBusinesses \| socialMedia \| supplyChainManagement \| taxManagement \| telecommunications \| ticServices \| tourism \| tracking \| trading \| training \| transportation \| travel \| ventureCapital \| video \| videoStreaming \| voip \| webDesign \| wellness[]	No	list of recipient category
`filter__departments`	`string[]`	No	Departments
`filter__recipientIds`	`string[]`	No	Recipientids
`filter__recipientState`	`string[]`	No	Recipientstate
`filter__discoverySource`	`string[]`	No	Discoverysource
`filter__subProcessorIds`	`string[]`	No	Subprocessorids
`filter__automationStatus`	`string[]`	No	Automationstatus
`filter__recipientWarranties`	`string[]`	No	Recipientwarranties
`filter__withNoProcessingActivity`	`boolean`	No	Withnoprocessingactivity

filter__usedIn full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    exportTypes?: string,
    filter__search?: string,
    filter__status?: string,
    filter__categories?: string,
    filter__departments?: string,
    filter__recipientIds?: string,
    filter__recipientState?: string,
    filter__discoverySource?: string,
    filter__subProcessorIds?: string,
    filter__automationStatus?: string,
    filter__recipientWarranties?: string,
    filter__withNoProcessingActivity?: boolean,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

filterRecipientsList

recipients.filterRecipientsList Filter recipients list Risk: read

await corsair.borneo.api.recipients.filterRecipientsList({});

Input: empty object Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listDiscoveredRecipients

recipients.listDiscoveredRecipients List discovered recipients Risk: read

await corsair.borneo.api.recipients.listDiscoveredRecipients({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the DiscoveredRecipient name.
`filter__status`	`ignored \| new`	No	Status of the discovered recipient. Can be new or ignored if it”s marked as ignored.
`filter__discoverySource`	`string[]`	No	Discoverysource

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    filter__discoverySource?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listFilterOptionsForRecipients

recipients.listFilterOptionsForRecipients List filter options for recipients Risk: read

await corsair.borneo.api.recipients.listFilterOptionsForRecipients({});

Input

Name	Type	Required	Description
`filterType`	`categories \| role`	Yes	Filtertype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listOrFilterRecipients

recipients.listOrFilterRecipients List or filter recipients Risk: read

await corsair.borneo.api.recipients.listOrFilterRecipients({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`filter__role`	`string[]`	No	Role
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the Recipient name.
`filter__status`	`archived \| validated`	No	The status of the recipient. Can be archived or validated.
`filter__usedIn`	`object`	No	Usedin
`filter__categories`	ITInfrastructure \| accountingSoftware \| adminDepartment \| advertising \| airlines \| analytics \| apps \| artificialIntelligenceAi \| assetManagement \| audit \| automotive \| b2b \| bankCards \| bigData \| businessDevelopment \| businessIntelligence \| businessManagement \| chat \| cloudComputing \| cloudDataServices \| cloudManagement \| cloudSecurity \| cloudStorage \| communities \| compliance \| construction \| consulting \| consumerElectronics \| content \| coreBankingSystem \| crmSoftware \| cryptoCurrency \| customerServiceProvider \| customerSupport \| cyberSecurity \| dataIntegration \| dataManagement \| dataStorage \| dataVisualization \| database \| developerTools \| devops \| digitalMedia \| documentManagement \| e-learning \| eCommerce \| edtech \| education \| electronics \| emailMarketing \| emailServices \| energy \| enterprise \| enterpriseSoftware \| erpSoftware \| events \| eventsSoftware \| fileSharing \| financialCrime \| financialServices \| fintech \| fitness \| foodAndBeverage \| government \| healthCare \| hospitality \| hosting \| identityManagement \| informationTechnology \| insurance \| insurtech \| internalDepartment \| internetOfThings \| itDepartment \| lawEnforcement \| lawServices \| legalDepartment \| logistics \| machineLearning \| management \| marketResearch \| marketingAutomation \| marketingDepartment \| marketingSoftware \| marketingTools \| marketplace \| medical \| messagingServices \| mobileApps \| mobilityEquipment \| networkSecurity \| news \| nonProfit \| officeApplications \| officesApps \| onlinePortals \| orderingSoftware \| other \| outsourcing \| passwordManagement \| paymentPlatform \| payrollServices \| pharmaceuticals \| physicalSecurity \| physicalStorage \| prDepartment \| preventionRisks \| productionDepartment \| productivityTools \| professionalServices \| projectManagement \| propertyAdministration \| publicAdministration \| publishing \| realEstate \| regulatoryReporting \| retail \| riskManagement \| rrhhDepartment \| rrhhManagement \| rrhhSoftware \| saas \| searchEngine \| security \| securityServices \| sellDepartment \| servicesPlatform \| smallAndMediumBusinesses \| socialMedia \| supplyChainManagement \| taxManagement \| telecommunications \| ticServices \| tourism \| tracking \| trading \| training \| transportation \| travel \| ventureCapital \| video \| videoStreaming \| voip \| webDesign \| wellness[]	No	list of recipient category
`filter__departments`	`string[]`	No	Departments
`filter__recipientIds`	`string[]`	No	Recipientids
`filter__recipientState`	`string[]`	No	Recipientstate
`filter__discoverySource`	`string[]`	No	Discoverysource
`filter__subProcessorIds`	`string[]`	No	Subprocessorids
`filter__automationStatus`	`string[]`	No	Automationstatus
`filter__recipientWarranties`	`string[]`	No	Recipientwarranties
`filter__withNoProcessingActivity`	`boolean`	No	Withnoprocessingactivity

filter__usedIn full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    filter__categories?: string,
    filter__departments?: string,
    filter__recipientIds?: string,
    filter__recipientState?: string,
    filter__discoverySource?: string,
    filter__subProcessorIds?: string,
    filter__automationStatus?: string,
    filter__recipientWarranties?: string,
    filter__withNoProcessingActivity?: boolean,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postDiscoveredRecipientById

recipients.postDiscoveredRecipientById Post discovered recipient by id Risk: read

await corsair.borneo.api.recipients.postDiscoveredRecipientById({});

Input

Name	Type	Required	Description
`discoveredRecipientId`	`string`	Yes	Discoveredrecipientid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDiscoveredRecipientById

recipients.retrieveDiscoveredRecipientById Retrieve discovered recipient by id Risk: read

await corsair.borneo.api.recipients.retrieveDiscoveredRecipientById({});

Input

Name	Type	Required	Description
`discoveredRecipientId`	`string`	Yes	Identifier of the discovered recipient.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    discoveredRecipientId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveRecipientDetails

recipients.retrieveRecipientDetails Retrieve recipient details Risk: read

await corsair.borneo.api.recipients.retrieveRecipientDetails({});

Input

Name	Type	Required	Description
`recipientId`	`string`	Yes	Identifier of the Recipient

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveRecipientProcessingActivities

recipients.retrieveRecipientProcessingActivities Retrieve recipient processing activities Risk: read

await corsair.borneo.api.recipients.retrieveRecipientProcessingActivities({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`recipientId`	`string`	Yes	Identifier of the Recipient
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sort__column?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateDashboardReportFrequencyAndRecipients

recipients.updateDashboardReportFrequencyAndRecipients Update dashboard report frequency and recipients Risk: write

await corsair.borneo.api.recipients.updateDashboardReportFrequencyAndRecipients({});

Input

Name	Type	Required	Description
`roles`	`borneo_admin \| borneo_analyst \| borneo_engineer \| compliance_engineer \| data_engineer \| department_coordinator \| no_access_role \| privacy_supervisor[]`	No	Roles
`frequency`	`/30 * * * \| 0 /1 * * \| 0 /12 * * \| 0 /4 * * \| 0 /6 * * \| 0 /8 * * \| 0 0 * * * \| 0 0 * * 0 \| 0 0 1 * * \| 0 0 1 1,4,7,10 * \| 0 0 1 1,7 *`	No	The 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.
`externalEmail`	`string[]`	No	Externalemail
`recipientsEmail`	`string[]`	No	Recipientsemail
`dashboardReportId`	`string`	Yes	Dashboardreportid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    roles?: string,
    frequency?: string,
    recipientsEmail?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateRecipientDetailsById

recipients.updateRecipientDetailsById Update recipient details by id Risk: write

await corsair.borneo.api.recipients.updateRecipientDetailsById({});

Input

Name	Type	Required	Description
`dpa`	`string`	No	The url to the DPA of the recipient
`name`	`string`	Yes	Name of the recipient. Has to be unique, 2 different recipients can”t have the same name.
`role`	`controller \| independent_controller \| joint_controller \| processor \| sub_processor[]`	No	Role
`state`	`AK \| AL \| AR \| AZ \| CA \| CO \| CT \| DC \| DE \| FL \| GA \| HI \| IA \| ID \| IL \| IN \| KS \| KY \| LA \| MA \| MD \| ME \| MI \| MN \| MO \| MS \| MT \| NC \| ND \| NE \| NH \| NJ \| NM \| NV \| NY \| OH \| OK \| OR \| PA \| RI \| SC \| SD \| TN \| TX \| UT \| VA \| VT \| WA \| WI \| WV \| WY`	No	2 letter code that identifies the state of the recipient. It only applies when the recipient country is US
`status`	`archived \| validated`	Yes	The status of the recipient. Can be archived or validated.
`country`	`string`	No	2 letter code that identifies a country.
`dpaFiles`	`string[]`	No	List of uploaded file ids.
`dpaStatus`	`attached \| notRequired \| requested`	No	The 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.
`categories`	ITInfrastructure \| accountingSoftware \| adminDepartment \| advertising \| airlines \| analytics \| apps \| artificialIntelligenceAi \| assetManagement \| audit \| automotive \| b2b \| bankCards \| bigData \| businessDevelopment \| businessIntelligence \| businessManagement \| chat \| cloudComputing \| cloudDataServices \| cloudManagement \| cloudSecurity \| cloudStorage \| communities \| compliance \| construction \| consulting \| consumerElectronics \| content \| coreBankingSystem \| crmSoftware \| cryptoCurrency \| customerServiceProvider \| customerSupport \| cyberSecurity \| dataIntegration \| dataManagement \| dataStorage \| dataVisualization \| database \| developerTools \| devops \| digitalMedia \| documentManagement \| e-learning \| eCommerce \| edtech \| education \| electronics \| emailMarketing \| emailServices \| energy \| enterprise \| enterpriseSoftware \| erpSoftware \| events \| eventsSoftware \| fileSharing \| financialCrime \| financialServices \| fintech \| fitness \| foodAndBeverage \| government \| healthCare \| hospitality \| hosting \| identityManagement \| informationTechnology \| insurance \| insurtech \| internalDepartment \| internetOfThings \| itDepartment \| lawEnforcement \| lawServices \| legalDepartment \| logistics \| machineLearning \| management \| marketResearch \| marketingAutomation \| marketingDepartment \| marketingSoftware \| marketingTools \| marketplace \| medical \| messagingServices \| mobileApps \| mobilityEquipment \| networkSecurity \| news \| nonProfit \| officeApplications \| officesApps \| onlinePortals \| orderingSoftware \| other \| outsourcing \| passwordManagement \| paymentPlatform \| payrollServices \| pharmaceuticals \| physicalSecurity \| physicalStorage \| prDepartment \| preventionRisks \| productionDepartment \| productivityTools \| professionalServices \| projectManagement \| propertyAdministration \| publicAdministration \| publishing \| realEstate \| regulatoryReporting \| retail \| riskManagement \| rrhhDepartment \| rrhhManagement \| rrhhSoftware \| saas \| searchEngine \| security \| securityServices \| sellDepartment \| servicesPlatform \| smallAndMediumBusinesses \| socialMedia \| supplyChainManagement \| taxManagement \| telecommunications \| ticServices \| tourism \| tracking \| trading \| training \| transportation \| travel \| ventureCapital \| video \| videoStreaming \| voip \| webDesign \| wellness[]	No	list of recipient category
`recipientId`	`string`	Yes	Identifier of the Recipient
`businessName`	`string`	No	Business name of the recipient
`recipientState`	`active \| assessment`	No	Recipientstate
`subProcessorIds`	`string[]`	No	Subprocessorids
`automationStatus`	`created \| ignored \| new`	No	Automationstatus
`dataStorageLocation`	`string[]`	Yes	List of countries where the data related to this recipient are stored
`recipientWarranties`	`string[]`	Yes	List of lawful basis types that applies to the recipient.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    dpa?: string,
    name?: string,
    role?: string,
    state?: string,
    status?: string,
    country?: string,
    dpaFiles?: string,
    dpaStatus?: string,
    categories?: string,
    businessName?: string,
    recipientState?: string,
    subProcessorIds?: string,
    automationStatus?: string,
    dataStorageLocation?: string,
    recipientWarranties?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

updateRecipientStatusViaId

recipients.updateRecipientStatusViaId Update recipient status via id Risk: write

await corsair.borneo.api.recipients.updateRecipientStatusViaId({});

Input

Name	Type	Required	Description
`status`	`archived \| validated`	No	The status of the recipient. Can be archived or validated.
`recipientId`	`string`	Yes	Identifier of the Recipient
`automationStatus`	`created \| ignored \| new`	No	Automationstatus

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    status?: string,
    automationStatus?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Resources

deleteTagFromResource

resources.deleteTagFromResource Delete tag from resource Risk: destructive

await corsair.borneo.api.resources.deleteTagFromResource({});

Input

Name	Type	Required	Description
`tagKey`	`string`	Yes	Tagkey
`tagValue`	`string`	No	Tagvalue
`tagResources`	`object`	Yes	Tagresources

tagResources full type

{
}

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

exportFilteredLeafResources

resources.exportFilteredLeafResources Export filtered leaf resources Risk: read

await corsair.borneo.api.resources.exportFilteredLeafResources({});

Input

Name	Type	Required	Description
`detailed`	`boolean`	No	Set to `true` if the results exported to have detailed column level information of the detected infotypes.
`sourceType`	`string`	No	Filter resource based on the source type. eg: “MYSQL”, “RDS_MYSQL”, “S3”, “PRESTO”, etc.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__region`	`string[]`	No	One or more cloud provider regions.
`filter__schema`	`string[]`	No	List tables from a specific schema. Supported for the following resource types: Presto.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__status`	`string[]`	No	Filter the resources based on list of status.
`filter__account`	`string[]`	No	One or more cloud provider account IDs.
`filter__dataset`	`string[]`	No	List tables from a specific dataset. Supported for on the following resource types: BigQuery.
`filter__driveId`	`string[]`	No	List drives from a specific driveId. Supported for the following resource types: Gdrive.
`filter__noOwner`	`boolean`	No	Include only resources that have not been assigned an owner.
`filter__scanned`	`boolean`	No	Include only resources that have been scanned.
`filter__database`	`string[]`	No	List tables from a specific database. Supported for the following resource types: (RDS) PostgreSQL, (RDS) MySQL, MongoDB.
`filter__hasOwner`	`boolean`	No	Include only resources that have been assigned an owner.
`filter__instance`	`string[]`	No	One or more resource IDs of the instances to which the resources belong, i.e. the parent resource ID.
`filter__parentId`	`string`	No	Filter the resources which has the specified parent ID.
`filter__driveType`	`string[]`	No	List drives from a specific drive type. Supported for the following resource types: Gdrive.
`filter__firstSeen`	`object`	No	Set of conditions for comparing two timestamps.
`filter__orgUnitId`	`string[]`	No	List orgUnits from a specific orgUnitIds. Supported for the following resource types: Gdrive.
`filter__spaceType`	`string[]`	No	Filter conlfluences based on type
`filter__categories`	`string[]`	No	Filter the resources matching with the list of categories.
`filter__resourceId`	`string[]`	No	Filter the resources with the specified resource IDs.
`filter__spaceStatus`	`string[]`	No	Filter conlfluences based on status
`filter__resourceTags`	`object[]`	No	Filter the resources based on tags
`filter__resourceType`	`string[]`	No	Filter the resources which can be scanned by Borneo.
`filter__severityScore`	`CRITICAL \| HIGH \| INFORMATIONAL \| LOW \| MEDIUM[]`	No	Filter the resources based on the assigned risk severity score; “critical” = 4, “high” = 3, “medium” = 2, “low” = 1.
`filter__classification`	`string[]`	No	Filter the resources matching with the list of classifications.
`filter__infoTypes__ops`	`AND \| OR`	No	Ops
`filter__infoTypes__infoTypes`	`string[]`	No	The list of infotypes to filter on.

filter__firstSeen full type

{
  additionalProperties?: number
}

filter__resourceTags full type

{
  source: string,
  tagKey: string,
  tagValue: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    detailed?: boolean,
    sourceType?: string,
    sort__column?: string,
    filter__region?: string,
    filter__schema?: string,
    filter__search?: string,
    filter__status?: string,
    filter__account?: string,
    filter__dataset?: string,
    filter__driveId?: string,
    filter__noOwner?: boolean,
    filter__scanned?: boolean,
    filter__database?: string,
    filter__hasOwner?: boolean,
    filter__instance?: string,
    filter__parentId?: string,
    filter__driveType?: string,
    filter__firstSeen?: number,
    filter__orgUnitId?: string,
    filter__spaceType?: string,
    filter__categories?: string,
    filter__resourceId?: string,
    filter__spaceStatus?: string,
    filter__resourceTags?: string,
    filter__resourceType?: string,
    filter__severityScore?: string,
    filter__classification?: string,
    filter__infoTypes__infoTypes?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

exportInventoryResourceList

resources.exportInventoryResourceList Export inventory resource list Risk: read

await corsair.borneo.api.resources.exportInventoryResourceList({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	A list of property names to return in the response. If not specified, all resource properties will be returned.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Optional “nextToken” value from the last API response.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__hasPii`	`boolean`	No	Include only resources that have a high likelihood of containing PII based on the resource metadata.
`filter__region`	`string`	No	The region of the cloud account to which the resoure belongs.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__noOwner`	`boolean`	No	Include only resources that have not been assigned an owner.
`filter__regions`	`string[]`	No	List of regions to which the resoure belongs to in that cloud account.
`filter__hasOwner`	`boolean`	No	Include only resources that have been assigned an owner.
`filter__parentId`	`string`	No	The parent Id of the resource. E.g. Borneo-specific GCP subscription ID for GCP resources
`filter__accountId`	`string`	No	The account ID of the cloud account to which the resoure belongs. E.g. a 12-digit AWS account ID.
`filter__dataRisks`	`string[]`	No	Filter the resources that has data risks.
`filter__firstSeen`	`object`	No	Set of conditions for comparing two timestamps.
`filter__resourceIds`	`string[]`	No	One or more resource IDs to return.
`filter__resourceTags`	`object[]`	No	Filter the resources based on tags
`filter__resourceType`	`string`	No	Filter the resources based on the resource type.
`filter__severityScore`	`number[]`	No	Filter the resources based on the assigned risk severity score; “critical” = 4, “high” = 3, “medium” = 2, “low” = 1.
`filter__classification`	`string[]`	No	Filter the resources based on classification and are non-compliant. eg “PII_L1”, “PII_L2”, “PII_L3”. Custom added classifications is also supported.
`include__violationMetrics`	`boolean`	No	Include violation count by severity for resource and child resources.
`filter__hideBorneoResources`	`boolean`	No	Whether to hide resources that are part of the Borneo data plane.
`filter__dataSourceCategories`	`AWSDataStores \| AzureDataStores \| CloudApplications \| DiscoveredApplications \| GCPDataStores \| StandaloneDataStores[]`	No	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__scannableResourceTypes`	`boolean`	No	Filter the resources that are scannable
`include__frameworkExceptionsCount`	`boolean`	No	Include framework exceptions count for the resource and its children
`include__childResourceStats__scans`	`boolean`	No	Include aggregate scan stats from child resources.
`include__childResourceStats__dataSize`	`boolean`	No	Include aggregate data size stats from child resources.

filter__firstSeen full type

{
  additionalProperties?: number
}

filter__resourceTags full type

{
  source: string,
  tagKey: string,
  tagValue: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    select?: string,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__hasPii?: boolean,
    filter__region?: string,
    filter__search?: string,
    filter__noOwner?: boolean,
    filter__regions?: string,
    filter__hasOwner?: boolean,
    filter__parentId?: string,
    filter__accountId?: string,
    filter__dataRisks?: string,
    filter__firstSeen?: number,
    filter__resourceIds?: string,
    filter__resourceTags?: string,
    filter__resourceType?: string,
    filter__severityScore?: number,
    filter__classification?: string,
    include__violationMetrics?: boolean,
    filter__hideBorneoResources?: boolean,
    filter__dataSourceCategories?: string,
    filter__scannableResourceTypes?: boolean,
    include__frameworkExceptionsCount?: boolean,
    include__childResourceStats__scans?: boolean,
    include__childResourceStats__dataSize?: boolean,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getResourceInventoryById

resources.getResourceInventoryById Get resource inventory by id Risk: read

await corsair.borneo.api.resources.getResourceInventoryById({});

Input

Name	Type	Required	Description
`resourceId`	`string`	Yes	The unique resource ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listInventoryResourcesWithFilters

resources.listInventoryResourcesWithFilters List inventory resources with filters Risk: read

await corsair.borneo.api.resources.listInventoryResourcesWithFilters({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	A list of property names to return in the response. If not specified, all resource properties will be returned.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Optional “nextToken” value from the last API response.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__hasPii`	`boolean`	No	Include only resources that have a high likelihood of containing PII based on the resource metadata.
`filter__region`	`string`	No	The region of the cloud account to which the resoure belongs.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__noOwner`	`boolean`	No	Include only resources that have not been assigned an owner.
`filter__regions`	`string[]`	No	List of regions to which the resoure belongs to in that cloud account.
`filter__hasOwner`	`boolean`	No	Include only resources that have been assigned an owner.
`filter__parentId`	`string`	No	The parent Id of the resource. E.g. Borneo-specific GCP subscription ID for GCP resources
`filter__accountId`	`string`	No	The account ID of the cloud account to which the resoure belongs. E.g. a 12-digit AWS account ID.
`filter__dataRisks`	`string[]`	No	Filter the resources that has data risks.
`filter__firstSeen`	`object`	No	Set of conditions for comparing two timestamps.
`filter__resourceIds`	`string[]`	No	One or more resource IDs to return.
`filter__resourceTags`	`object[]`	No	Filter the resources based on tags
`filter__resourceType`	`string`	No	Filter the resources based on the resource type.
`filter__severityScore`	`number[]`	No	Filter the resources based on the assigned risk severity score; “critical” = 4, “high” = 3, “medium” = 2, “low” = 1.
`filter__classification`	`string[]`	No	Filter the resources based on classification and are non-compliant. eg “PII_L1”, “PII_L2”, “PII_L3”. Custom added classifications is also supported.
`include__violationMetrics`	`boolean`	No	Include violation count by severity for resource and child resources.
`filter__hideBorneoResources`	`boolean`	No	Whether to hide resources that are part of the Borneo data plane.
`filter__dataSourceCategories`	`AWSDataStores \| AzureDataStores \| CloudApplications \| DiscoveredApplications \| GCPDataStores \| StandaloneDataStores[]`	No	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__scannableResourceTypes`	`boolean`	No	Filter the resources that are scannable
`include__frameworkExceptionsCount`	`boolean`	No	Include framework exceptions count for the resource and its children
`include__childResourceStats__scans`	`boolean`	No	Include aggregate scan stats from child resources.
`include__childResourceStats__dataSize`	`boolean`	No	Include aggregate data size stats from child resources.

filter__firstSeen full type

{
  additionalProperties?: number
}

filter__resourceTags full type

{
  source: string,
  tagKey: string,
  tagValue: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    select?: string,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__hasPii?: boolean,
    filter__region?: string,
    filter__search?: string,
    filter__noOwner?: boolean,
    filter__regions?: string,
    filter__hasOwner?: boolean,
    filter__parentId?: string,
    filter__accountId?: string,
    filter__dataRisks?: string,
    filter__firstSeen?: number,
    filter__resourceIds?: string,
    filter__resourceTags?: string,
    filter__resourceType?: string,
    filter__severityScore?: number,
    filter__classification?: string,
    include__violationMetrics?: boolean,
    filter__hideBorneoResources?: boolean,
    filter__dataSourceCategories?: string,
    filter__scannableResourceTypes?: boolean,
    include__frameworkExceptionsCount?: boolean,
    include__childResourceStats__scans?: boolean,
    include__childResourceStats__dataSize?: boolean,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listLeafResourcesWithFilters

resources.listLeafResourcesWithFilters List leaf resources with filters Risk: read

await corsair.borneo.api.resources.listLeafResourcesWithFilters({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Optional “nextToken” value from the last API response.
`sourceType`	`string`	No	Filter resource based on the resource type.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__region`	`string[]`	No	One or more cloud provider regions.
`filter__schema`	`string[]`	No	List tables from a specific schema. Supported for the following resource types: Presto.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__status`	`string[]`	No	Filter the resources based on list of status.
`filter__account`	`string[]`	No	One or more cloud provider account IDs.
`filter__dataset`	`string[]`	No	List tables from a specific dataset. Supported for on the following resource types: BigQuery.
`filter__driveId`	`string[]`	No	List drives from a specific driveId. Supported for the following resource types: Gdrive.
`filter__noOwner`	`boolean`	No	Include only resources that have not been assigned an owner.
`filter__scanned`	`boolean`	No	Include only resources that have been scanned.
`filter__database`	`string[]`	No	List tables from a specific database. Supported for the following resource types: (RDS) PostgreSQL, (RDS) MySQL, MongoDB.
`filter__hasOwner`	`boolean`	No	Include only resources that have been assigned an owner.
`filter__instance`	`string[]`	No	One or more resource IDs of the instances to which the resources belong, i.e. the parent resource ID.
`filter__parentId`	`string`	No	Filter the resources which has the specified parent ID.
`filter__driveType`	`string[]`	No	List drives from a specific drive type. Supported for the following resource types: Gdrive.
`filter__firstSeen`	`object`	No	Set of conditions for comparing two timestamps.
`filter__orgUnitId`	`string[]`	No	List orgUnits from a specific orgUnitIds. Supported for the following resource types: Gdrive.
`filter__spaceType`	`string[]`	No	Filter conlfluences based on type
`filter__categories`	`string[]`	No	Filter the resources matching with the list of categories.
`filter__resourceId`	`string[]`	No	Filter the resources with the specified resource IDs.
`filter__spaceStatus`	`string[]`	No	Filter conlfluences based on status
`filter__resourceTags`	`object[]`	No	Filter the resources based on tags
`filter__resourceType`	`string[]`	No	Filter the resources which can be scanned by Borneo.
`filter__severityScore`	`CRITICAL \| HIGH \| INFORMATIONAL \| LOW \| MEDIUM[]`	No	Filter the resources based on the assigned risk severity score; “critical” = 4, “high” = 3, “medium” = 2, “low” = 1.
`filter__classification`	`string[]`	No	Filter the resources matching with the list of classifications.
`filter__infoTypes__ops`	`AND \| OR`	No	Ops
`include__violationSummary`	`boolean`	No	Violationsummary
`filter__infoTypes__infoTypes`	`string[]`	No	The list of infotypes to filter on.
`include__frameworkExceptionsCount`	`boolean`	No	Frameworkexceptionscount

filter__firstSeen full type

{
  additionalProperties?: number
}

filter__resourceTags full type

{
  source: string,
  tagKey: string,
  tagValue: string
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string,
    sourceType?: string,
    sort__column?: string,
    filter__region?: string,
    filter__schema?: string,
    filter__search?: string,
    filter__status?: string,
    filter__account?: string,
    filter__dataset?: string,
    filter__driveId?: string,
    filter__noOwner?: boolean,
    filter__scanned?: boolean,
    filter__database?: string,
    filter__hasOwner?: boolean,
    filter__instance?: string,
    filter__parentId?: string,
    filter__driveType?: string,
    filter__firstSeen?: number,
    filter__orgUnitId?: string,
    filter__spaceType?: string,
    filter__categories?: string,
    filter__resourceId?: string,
    filter__spaceStatus?: string,
    filter__resourceTags?: string,
    filter__resourceType?: string,
    filter__severityScore?: string,
    filter__classification?: string,
    include__violationSummary?: boolean,
    filter__infoTypes__infoTypes?: string,
    include__frameworkExceptionsCount?: boolean,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postClassificationStats

resources.postClassificationStats Post classification stats Risk: read

await corsair.borneo.api.resources.postClassificationStats({});

Input

Name	Type	Required	Description
`filter__classification`	`string`	No	Classification

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postResourceLineageFilter

resources.postResourceLineageFilter Post resource lineage filter Risk: read

await corsair.borneo.api.resources.postResourceLineageFilter({});

Input

Name	Type	Required	Description
`filter__resourceId`	`string`	No	Resourceid
`filter__upstreamDepth`	`number`	No	Upstreamdepth
`filter__downstreamDepth`	`number`	No	Downstreamdepth

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    filter__upstreamDepth?: number,
    filter__downstreamDepth?: number,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postResourceStatsWithDeletedResources

resources.postResourceStatsWithDeletedResources Post resource stats with deleted resources Risk: read

await corsair.borneo.api.resources.postResourceStatsWithDeletedResources({});

Input

Name	Type	Required	Description
`includeDeletedResources`	`boolean`	No	Includedeletedresources

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    includeDeletedResources?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveDataResourceStatistics

resources.retrieveDataResourceStatistics Retrieve data resource statistics Risk: read

await corsair.borneo.api.resources.retrieveDataResourceStatistics({});

Input

Name	Type	Required	Description
`sourceType`	`string`	No	Sourcetype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveResourceCatalogById

resources.retrieveResourceCatalogById Retrieve resource catalog by id Risk: read

await corsair.borneo.api.resources.retrieveResourceCatalogById({});

Input

Name	Type	Required	Description
`resourceId`	`string`	Yes	The unique resource ID.
`includeParentDetails`	`boolean`	No	Includeparentdetails

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    includeParentDetails?: boolean
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

retrieveResourceColumns

resources.retrieveResourceColumns Retrieve resource columns Risk: read

await corsair.borneo.api.resources.retrieveResourceColumns({});

Input

Name	Type	Required	Description
`dataspace`	`string[]`	No	Dataspace
`searchKey`	`string`	No	Searchkey
`resourceId`	`string[]`	No	Resourceid
`sourceType`	`string`	No	Sourcetype
`parentResourceId`	`string`	Yes	Parentresourceid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Scans

accessScanIterationById

scans.accessScanIterationById Access scan iteration by id Risk: read

await corsair.borneo.api.scans.accessScanIterationById({});

Input

Name	Type	Required	Description
`scanIterationId`	`string`	Yes	The unique resource ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

createAndScheduleCloudResourceScan

scans.createAndScheduleCloudResourceScan Create and schedule cloud resource scan Risk: write

await corsair.borneo.api.scans.createAndScheduleCloudResourceScan({});

Input

Name	Type	Required	Description
`cron`	`/30 * * * \| 0 /1 * * \| 0 /12 * * \| 0 /4 * * \| 0 /6 * * \| 0 /8 * * \| 0 0 * * * \| 0 0 * * 0 \| 0 0 1 * * \| 0 0 1 1,4,7,10 * \| 0 0 1 1,7 *`	No	The 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.
`name`	`string`	No	The name of the scan.
`scanType`	`full \| sample`	No	The type of scan to perform, i.e. either full scan or sample scan.
`scanFilter`	`object[]`	No	Filter conditions to apply to the scan.
`connectorId`	`string`	No	The ID of the connector to use for the scan. The connector type must match the resource type.
`resourceType`	`string`	No	The type of resource to scan.
`scheduleType`	`cron \| once`	Yes	A 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.
`resources__all`	`boolean`	No	Set 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__name`	`string[]`	No	Name
`resources__tags`	`object[]`	No	Filter the resources which have teh tags
`resources__region`	`string`	No	The region of the cloud account to which the resoure belongs.
`resources__schema`	`string[]`	No	Filter the resources with the list of schemas for selected connector types
`resources__search`	`string`	No	Free-text search on the resource name.
`resources__teamId`	`string`	No	Slack Workspace id in Slack Enterprise Connector
`resources__dataset`	`string[]`	No	Filter the resources with the list of datasetss for selected connector types
`resources__driveId`	`string[]`	No	Filter the resources with the list of driveIds for gdrive connector types
`resources__regions`	`string[]`	No	List of regions to which the resoure belongs to in that cloud account.
`resources__teamUrl`	`string`	No	Slack Workspace URL in Slack Enterprise Connector
`schedule__timezone`	`string`	No	time zone to be considered for the schedule
`resources__database`	`string[]`	No	Filter the resources with the list of databaseses for selected connector types
`resources__isPublic`	`boolean`	No	Filter the resources which are public.
`resources__parentId`	`string`	No	Filter the resources which has the specified parent id.
`resources__teamName`	`string`	No	Slack Workspace name in Slack Enterprise Connector
`schedule__calendars`	`object[]`	No	List of schedules
`resources__accountId`	`string`	No	The account ID of the cloud account to which the resoure belongs. E.g. a 12-digit AWS account ID.
`resources__driveType`	`string[]`	No	Filter the resources with the list of driveTypes for gdrive connector types
`resources__isPrivate`	`boolean`	No	Private channels, for Slack Enterprise Connector
`resources__orgUnitId`	`string[]`	No	Filter the resources with the list of orgUnits for gdrive connector types
`resources__spaceType`	`string[]`	No	Filter conlfluences based on type
`resources__isArchived`	`boolean`	No	Filter the channels marked as archived for Slack connector types
`resources__isExternal`	`boolean`	No	Filter the channels marked as external for Slack connector types
`resources__resourceIds`	`string[]`	No	One or more resource IDs to return.
`resources__spaceStatus`	`string[]`	No	Filter conlfluences based on status
`resources__googleGroups`	`string[]`	No	Googlegroups
`resources__resourceType`	`string`	No	Filter the resources based on the resource type.
`resources__isUnencrypted`	`boolean`	No	Filter the resources which are un-unencrypted.
`resources__infoTypes__ops`	`AND \| OR`	No	Ops
`resources__zendeskGroupId`	`number[]`	No	Zendeskgroupid
`scanLimits__itemsPerBatch`	`number`	No	Maximum 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__infotypes`	`string[]`	No	List of infotypes to scan for. If empty, all enabled infotypes will be included.
`inspectionPolicy__compliance`	`string[]`	No	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__samplePercentage`	`number`	No	Percentage of data to scan per resource. Supported for full scans on the following resource types: S3, BigQuery.
`inspectionPolicy__maskDetails`	`boolean`	No	If 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__collectTokens`	`boolean`	No	If 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__infoTypes`	`string[]`	No	The list of infotypes to filter on.
`resources__isSlackDirectMessages`	`boolean`	No	Fetch DMs, for Slack Enterprise Connector
`scanLimits__sampleDurationMinutes`	`number`	No	Sampledurationminutes
`scanLimits__maxCumulativeDataSizeMb`	`number`	No	Maximum data size to scan per resource in MB. Supported for full scans on the following resource types: PostgreSQL, MySQL.

scanFilter full type

{
  type?: fileExtensions | internalDomains | jiraProjects | lastModifiedGreaterThan | lastModifiedLessThan | onlyIncludeKeys | prefix | scanAttachments | visibilityFilter | zendeskGroups,
  filters?: string[]
}[]

resources__tags full type

{
  action: exclude | include,
  tagKey: string,
  tagValue?: string
}[]

schedule__calendars full type

{
  hour?: number,
  year?: number,
  month?: APRIL | AUGUST | DECEMBER | FEBRUARY | JANUARY | JULY | JUNE | MARCH | MAY | NOVEMBER | OCTOBER | SEPTEMBER,
  minute?: number,
  second?: number,
  dayOfMonth?: number
}[]

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    cron?: string,
    scanType?: string,
    scanFilter?: string,
    connectorId?: string,
    resourceType?: string,
    scheduleType?: string,
    resources__all?: boolean,
    resources__tags?: string,
    resources__region?: string,
    resources__schema?: string,
    resources__search?: string,
    resources__teamId?: string,
    resources__dataset?: string,
    resources__driveId?: string,
    resources__regions?: string,
    resources__teamUrl?: string,
    schedule__timezone?: string,
    resources__database?: string,
    resources__isPublic?: boolean,
    resources__parentId?: string,
    resources__teamName?: string,
    schedule__calendars?: number,
    resources__accountId?: string,
    resources__driveType?: string,
    resources__isPrivate?: boolean,
    resources__orgUnitId?: string,
    resources__spaceType?: string,
    resources__isArchived?: boolean,
    resources__isExternal?: boolean,
    resources__resourceIds?: string,
    resources__spaceStatus?: string,
    resources__googleGroups?: string,
    resources__resourceType?: string,
    resources__isUnencrypted?: boolean,
    resources__infoTypes__ops?: string,
    resources__zendeskGroupId?: number,
    scanLimits__itemsPerBatch?: number,
    inspectionPolicy__infotypes?: string,
    inspectionPolicy__compliance?: string,
    scanLimits__samplePercentage?: number,
    inspectionPolicy__maskDetails?: boolean,
    inspectionPolicy__collectTokens?: boolean,
    resources__infoTypes__infoTypes?: string,
    resources__isSlackDirectMessages?: boolean,
    scanLimits__sampleDurationMinutes?: number,
    scanLimits__maxCumulativeDataSizeMb?: number
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

exportInsightPageUsingScanId

scans.exportInsightPageUsingScanId Export insight page using scanid Risk: read

await corsair.borneo.api.scans.exportInsightPageUsingScanId({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	The unique scan ID.
`detailed`	`boolean`	No	Set to `true` if the results exported to have detailed column level information of the detected infotypes with masked tokens if captured.
`filter__pageId`	`string`	No	Unique page ID. Only applicable to page-level results.
`filter__scanId`	`string`	No	Unique scan ID.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__status`	`deleted \| failed \| paused \| scanning \| success \| terminated[]`	No	Status
`filter__categories`	`string[]`	No	infotype categories
`filter__userEmails`	`string[]`	No	Useremails
`filter__resourceIds`	`string[]`	No	One or more resource IDs for which to retrieve results. Only applicable to page-level results.
`filter__resourceType`	`string`	No	Resource type to filter results by.
`filter__fileExtension`	`string[]`	No	Fileextension
`filter__infoTypes__ops`	`AND \| OR`	No	Ops
`filter__scanIterationId`	`string`	No	Unique scan iteration ID to fetch results for a specific run of
`filter__infotypeConfidence`	`certain \| likely \| potential[]`	No	Infotypeconfidence
`filter__infoTypes__infoTypes`	`string[]`	No	The list of infotypes to filter on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    detailed?: boolean,
    filter__pageId?: string,
    filter__search?: string,
    filter__status?: string,
    filter__categories?: string,
    filter__resourceIds?: string,
    filter__resourceType?: string,
    filter__fileExtension?: string,
    filter__scanIterationId?: string,
    filter__infotypeConfidence?: string,
    filter__infoTypes__infoTypes?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

filterAndListInspectionResults

scans.filterAndListInspectionResults Filter and list inspection results Risk: read

await corsair.borneo.api.scans.filterAndListInspectionResults({});

Input

Name	Type	Required	Description
`type`	`page \| scan`	Yes	Type of inspection result, i.e. scan-level or page-level results.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__pageId`	`string`	No	Unique page ID. Only applicable to page-level results.
`filter__scanId`	`string`	No	Unique scan ID.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__status`	`deleted \| failed \| paused \| scanning \| success \| terminated[]`	No	Status
`filter__categories`	`string[]`	No	infotype categories
`filter__userEmails`	`string[]`	No	Useremails
`filter__resourceIds`	`string[]`	No	One or more resource IDs for which to retrieve results. Only applicable to page-level results.
`filter__resourceType`	`string`	No	Resource type to filter results by.
`filter__fileExtension`	`string[]`	No	Fileextension
`filter__infoTypes__ops`	`AND \| OR`	No	Ops
`filter__scanIterationId`	`string`	No	Unique scan iteration ID to fetch results for a specific run of
`filter__infotypeConfidence`	`certain \| likely \| potential[]`	No	Infotypeconfidence
`filter__infoTypes__infoTypes`	`string[]`	No	The list of infotypes to filter on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    type?: string,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__pageId?: string,
    filter__search?: string,
    filter__status?: string,
    filter__categories?: string,
    filter__resourceIds?: string,
    filter__resourceType?: string,
    filter__fileExtension?: string,
    filter__scanIterationId?: string,
    filter__infotypeConfidence?: string,
    filter__infoTypes__infoTypes?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getInsightByTypeAndId

scans.getInsightByTypeAndId Get insight by type and id Risk: read

await corsair.borneo.api.scans.getInsightByTypeAndId({});

Input

Name	Type	Required	Description
`id`	`string`	Yes	The unique ID of the inspection result to fetch.
`type`	`page \| scan`	Yes	The type of inspection result to fetch.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string,
    type?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

getScanByScanId

scans.getScanByScanId Get scan by scanid Risk: read

await corsair.borneo.api.scans.getScanByScanId({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	Scanid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    scanId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listErrorDetailsFromFilteredScanIterations

scans.listErrorDetailsFromFilteredScanIterations List error details from filtered scan iterations Risk: read

await corsair.borneo.api.scans.listErrorDetailsFromFilteredScanIterations({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	List of column names to include in the response.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__scanId`	`string`	No	Scanid
`filter__accountId`	`string`	No	Accountid
`filter__resourceId`	`string`	No	Resourceid
`filter__scanExecutionId`	`string`	No	Scanexecutionid
`filter__scanIterationId`	`string`	No	Scaniterationid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    select?: string,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__scanExecutionId?: string,
    filter__scanIterationId?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listInsightFilters

scans.listInsightFilters List insight filters Risk: read

await corsair.borneo.api.scans.listInsightFilters({});

Input

Name	Type	Required	Description
`scanId`	`string`	No	Scanid
`filterType`	`fileExtension`	No	Filtertype

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listScanExecutionResults

scans.listScanExecutionResults List scan execution results Risk: read

await corsair.borneo.api.scans.listScanExecutionResults({});

Input

Name	Type	Required	Description
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	Nexttoken
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__scanId`	`string`	No	Unique scan ID.
`filter__search`	`string`	No	Free-text search on the resource name.
`filter__statuses`	`deleted \| failed \| paused \| scanning \| success \| terminated[]`	No	Statuses
`filter__resourceIds`	`string[]`	No	One or more resource IDs for which to retrieve results. Only applicable to page-level results.
`filter__infoTypes__ops`	`AND \| OR`	No	Ops
`filter__scanIterationId`	`string`	No	Scaniterationid
`filter__infotypeConfidence`	`certain \| likely \| potential[]`	No	One or more confidence matches for the scan.
`filter__infoTypes__infoTypes`	`string[]`	No	The list of infotypes to filter on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    sort__column?: string,
    filter__search?: string,
    filter__statuses?: string,
    filter__resourceIds?: string,
    filter__scanIterationId?: string,
    filter__infotypeConfidence?: string,
    filter__infoTypes__infoTypes?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listScanIterationsWithFilter

scans.listScanIterationsWithFilter List scan iterations with filter Risk: read

await corsair.borneo.api.scans.listScanIterationsWithFilter({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	List of column names to include in the response.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__scanId`	`string`	No	Scanid
`filter__resourceId`	`string`	No	Resourceid
`filter__scanIterationId`	`string`	No	Scaniterationid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    select?: string,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__scanIterationId?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listScansWithFilters

scans.listScansWithFilters List scans with filters Risk: read

await corsair.borneo.api.scans.listScansWithFilters({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	List of column names to include in the response.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Free-form text search to apply to the scan name.
`filter__status`	`string[]`	No	One or more scan statuses (e.g. `inprogress`, `completed`, etc.) to filter results by.
`filter__scanType`	`string[]`	No	One or more scan types (i.e. “full” or “sample”) to filter results by.
`getNextExecution`	`boolean`	No	IF true, nextExecution will be populated for postponed and repeated scans
`filter__accountId`	`string[]`	No	One or more AWS accounts to filter results by.
`filter__resources`	`string[]`	No	One or more resource IDs to filter results by.
`filter__connectorId`	`string[]`	No	One or more connector IDs to filter results by.
`filter__dataPlaneId`	`string[]`	No	One or more data plane IDs to filter results by.
`filter__gcpProjectId`	`string[]`	No	One or more GCP projects to filter results by.
`filter__resourceType`	`string[]`	No	One or moreresource types to filter results by.
`filter__dataPlaneName`	`string[]`	No	One or more data plane names to filter results by.
`filter__infoTypes__ops`	`AND \| OR`	No	Ops
`filter__infoTypes__infoTypes`	`string[]`	No	The list of infotypes to filter on.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    select?: string,
    pageSize?: number,
    nextToken?: string,
    sort__column?: string,
    filter__search?: string,
    filter__status?: string,
    filter__scanType?: string,
    getNextExecution?: boolean,
    filter__accountId?: string,
    filter__resources?: string,
    filter__connectorId?: string,
    filter__dataPlaneId?: string,
    filter__gcpProjectId?: string,
    filter__resourceType?: string,
    filter__dataPlaneName?: string,
    filter__infoTypes__infoTypes?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

markScanFalsePositivesById

scans.markScanFalsePositivesById Mark scan false positives by id Risk: write

await corsair.borneo.api.scans.markScanFalsePositivesById({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	The unique scan ID.
`reports`	`string[]`	No	Reports

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

pauseScanById

scans.pauseScanById Pause scan by id Risk: write

await corsair.borneo.api.scans.pauseScanById({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	The unique scan ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

postScanResourceStatus

scans.postScanResourceStatus Post scan resource status Risk: read

await corsair.borneo.api.scans.postScanResourceStatus({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	The unique scan ID.
`pageSize`	`number`	No	The 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.
`nextToken`	`string`	No	The `nextToken` from the last page of results to retrieve the next page of results.
`filter__name`	`string`	No	Name

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageSize?: number,
    nextToken?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

resumeScanById

scans.resumeScanById Resume scan by id Risk: write

await corsair.borneo.api.scans.resumeScanById({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	The unique scan ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

scanLegalDocumentById

scans.scanLegalDocumentById Scan legal document byid Risk: write

await corsair.borneo.api.scans.scanLegalDocumentById({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	Documentid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

stopScanViaScanId

scans.stopScanViaScanId Stop scan via scanid Risk: write

await corsair.borneo.api.scans.stopScanViaScanId({});

Input

Name	Type	Required	Description
`scanId`	`string`	Yes	The unique scan ID.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

submitDetailedScanResults

scans.submitDetailedScanResults Submit detailed scan results Risk: write

await corsair.borneo.api.scans.submitDetailedScanResults({});

Input

Name	Type	Required	Description
`pageId`	`string`	No	Page ID for one of the pages produced by the scan.
`scanId`	`string`	Yes	Scan ID of the scan that produced the inspection result.
`resourceId`	`string`	Yes	Resource ID for the resource for which the page was produced.
`scanIterationId`	`string`	Yes	ScanIteration ID of the scan that produced the inspection result.

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    pageId?: string,
    scanId?: string,
    resourceId?: string,
    scanIterationId?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Support

postSupportChatQuery

support.postSupportChatQuery Post support chat query Risk: write

await corsair.borneo.api.support.postSupportChatQuery({});

Input

Name	Type	Required	Description
`query`	`string`	Yes	Query
`sessionId`	`string`	No	Sessionid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

Users

getUserProfileById

users.getUserProfileById Get user profile by id Risk: read

await corsair.borneo.api.users.getUserProfileById({});

Input

Name	Type	Required	Description
`userId`	`string`	Yes	Userid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

listUserProfileWithFiltersAndSorting

users.listUserProfileWithFiltersAndSorting List user profile with filters and sorting Risk: read

await corsair.borneo.api.users.listUserProfileWithFiltersAndSorting({});

Input

Name	Type	Required	Description
`select`	`string[]`	No	Select
`pageSize`	`number`	No	Pagesize
`nextToken`	`string`	No	Nexttoken
`sort__order`	`ASC \| DESC`	No	Order
`sort__column`	`string`	No	The column name to sort on.
`filter__search`	`string`	No	Search

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    sort__column?: string,
    nextToken?: string,
    items?: string[]
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

verifyEmailWithIdAndToken

users.verifyEmailWithIdAndToken Verify email with id and token Risk: write

await corsair.borneo.api.users.verifyEmailWithIdAndToken({});

Input

Name	Type	Required	Description
`token`	`string`	Yes	Token
`verificationId`	`string`	Yes	Verificationid

Output

Name	Type	Required	Description
`data`	`object`	No	—
`error`	`object`	No	—
`successful`	`true`	Yes	—
`log_id`	`string`	No	—

data full type

{
  data?: {
    id?: string
  },
  error?: string,
  successful?: boolean
}

error full type

string | {
  message: string
}

​Accounts

​getCloudAccountById

​postAccountsWithFilterAndSortOptions

​retrieveAccountDetailsById

​Assets

​createNewAsset

​deleteAssetById

​filterAndSortAssetsList

​retrieveAssetById

​updateAssetInformationById

​Audit

​listEventsWithFilters

​postFilteredAccessLogs

​postLogAuditRecordsWithFilterCriteria

​Breaches

​deleteDataBreachById

​evaluateDataBreachImpact

​fetchDataBreachEvaluation

​listDataBreachesWithFilters

​listDataBreachFilters

​postDataBreachInformation

​retrieveDataBreachById

​updateDataBreachEntry

​Categories

​createNewInfotypeCategory

​deleteCategoryByLabel

​getCategoryByLabel

​updateCategoryInfotypes

​Connectors

​postConnectorWithFilteringOptions

​retrieveConnectorById

​Dashboard

​createDashboardUser

​deleteDashboardReportById

​disableDashboardUserByUsername

​downloadDashboardReport

​downloadDashboardReportEdition

​enableDashboardUser

​fetchDashboardReportById

​getDashboardReportEditionById

​listDashboardReportEditions

​listDashboardReportsWithFilters

​listDashboardUsersWithFilters

​postCurrentDashboardUser

​postDashboardReport

​removeDashboardUserByUsername

​resetDashboardUserPassword

​triggerDashboardReportByReportId

​updateDashboardUserDetails

​updateDashboardUserRoles

​Departments

​createDepartmentWithTranslations

​deleteDepartmentById

​getDepartmentFilterList

​listDepartmentsWithSortAndPagination

​retrieveDepartmentInformation

​updateDepartmentName

​Documents

​createLegalDocumentEntry

​deleteLegalDocumentById

​listDiscoveredDocument

​listLegalDocumentsWithPagination

​retrieveDiscoveredDocumentById

​retrieveLegalDocumentById

​updateDiscoveredDocumentStatus

​Domains

​createDomainWithPollingFrequency

​deleteDomainById

​getDomainById

​listDomainsWithPaginationAndSorting

​pollDomainById

​updateDomainDetails

​Employees

​createEmployeeWithJsonPayload

​deleteEmployeeById

​filterEmployeeList

​listEmployeesWithFilters

​retrieveEmployeeDetailsById

​updateEmployeeById

​Headquarters

Accounts

getCloudAccountById

postAccountsWithFilterAndSortOptions

retrieveAccountDetailsById

Assets

createNewAsset

deleteAssetById

filterAndSortAssetsList

retrieveAssetById

updateAssetInformationById

Audit

listEventsWithFilters

postFilteredAccessLogs

postLogAuditRecordsWithFilterCriteria

Breaches

deleteDataBreachById

evaluateDataBreachImpact

fetchDataBreachEvaluation

listDataBreachesWithFilters

listDataBreachFilters

postDataBreachInformation

retrieveDataBreachById

updateDataBreachEntry

Categories

createNewInfotypeCategory

deleteCategoryByLabel

getCategoryByLabel

updateCategoryInfotypes

Connectors

postConnectorWithFilteringOptions

retrieveConnectorById

Dashboard

createDashboardUser

deleteDashboardReportById

disableDashboardUserByUsername

downloadDashboardReport

downloadDashboardReportEdition

enableDashboardUser

fetchDashboardReportById

getDashboardReportEditionById

listDashboardReportEditions

listDashboardReportsWithFilters

listDashboardUsersWithFilters

postCurrentDashboardUser

postDashboardReport

removeDashboardUserByUsername

resetDashboardUserPassword

triggerDashboardReportByReportId

updateDashboardUserDetails

updateDashboardUserRoles

Departments

createDepartmentWithTranslations

deleteDepartmentById

getDepartmentFilterList

listDepartmentsWithSortAndPagination

retrieveDepartmentInformation

updateDepartmentName

Documents

createLegalDocumentEntry

deleteLegalDocumentById

listDiscoveredDocument

listLegalDocumentsWithPagination

retrieveDiscoveredDocumentById

retrieveLegalDocumentById

updateDiscoveredDocumentStatus

Domains

createDomainWithPollingFrequency

deleteDomainById

getDomainById

listDomainsWithPaginationAndSorting

pollDomainById

updateDomainDetails

Employees

createEmployeeWithJsonPayload

deleteEmployeeById

filterEmployeeList

listEmployeesWithFilters

retrieveEmployeeDetailsById

updateEmployeeById

Headquarters