{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/nuix/json-schema/nuix-bulk-ingestion-request-schema.json",
  "title": "BulkIngestionRequest",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/nuix-processing-api-openapi.yml#/components/schemas/BulkIngestionRequest",
  "type": "object",
  "properties": {
    "processorSettings": {
      "$ref": "#/$defs/ProcessorSettings"
    },
    "mimeTypeProcessorSettings": {
      "type": "array",
      "description": "Sets the processing settings for individual mime types.",
      "items": {
        "$ref": "#/$defs/MimeTypeProcessingSetting"
      }
    },
    "parallelProcessingSettings": {
      "$ref": "#/$defs/ParallelProcessingSettings"
    },
    "keystoreKeyParameters": {
      "type": "array",
      "description": "Sets the settings used to apply a keystore file to the ingestion.",
      "items": {
        "$ref": "#/$defs/KeyStoreKeyParameters"
      }
    },
    "rescanEvidenceRepositories": {
      "type": "boolean",
      "description": "If true, the case's Evidence Repositories will be rescanned to discover new Evidence Containers within them and new files within existing Evidence Containers which are themselves within the cases's Evidence Repositories. Default is false."
    },
    "rescanEvidenceRepositoriesSettings": {
      "$ref": "#/$defs/RescanEvidenceRepositoriesSettings"
    },
    "passwordDiscoverySettings": {
      "$ref": "#/$defs/PasswordDiscoverySettings"
    },
    "configurationProfile": {
      "type": "string",
      "description": "Deprecated in favor of processingProfile. Configuration profile to use as base set of processor, parallel processing, and mime type settings.  Values present in processorSettings, parallelProcessingSettings, and mimeTypeProcessorSettings will override anything defined by this profile.",
      "deprecated": true
    },
    "processingProfile": {
      "type": "string",
      "description": "The name of the Processing Profile to use. If you use this setting then do not use any other settings from processorSettings as everything will be overridden by the loaded Processing profile."
    },
    "repositories": {
      "type": "array",
      "description": "The list of evidence repositories to create",
      "items": {
        "$ref": "#/$defs/EvidenceRepository"
      }
    },
    "containers": {
      "type": "array",
      "description": "The list of evidence containers to create",
      "items": {
        "$ref": "#/$defs/EvidenceContainerWithTargets"
      }
    }
  },
  "$defs": {
    "EvidenceContainerWithTargets": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Sets the name for the evidence container that is created during ingestion."
        },
        "customMetadata": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Sets a map of custom metadata for the evidence container."
        },
        "encoding": {
          "type": "string",
          "description": "Sets the encoding for the evidence container. If the encoding is not set the default system encoding will be used."
        },
        "custodian": {
          "type": "string",
          "description": "Sets the name of the initial custodian for the data."
        },
        "timeZone": {
          "type": "string",
          "description": "Sets the time zone for the evidence container. If the time zone is not set the system's default time zone will be used."
        },
        "description": {
          "type": "string",
          "description": "Sets the description for the evidence container."
        },
        "locale": {
          "type": "string",
          "description": "Sets the locale for the evidence container. Some file types and named entities require a locale for them to be ingested accurately. If not set then the system's default locale will be used. Format is that required by IETF BCP 47 (e.g. 'en-US')."
        },
        "files": {
          "type": "array",
          "description": "A list of ingestible files to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleFile"
          }
        },
        "exchangeMailboxes": {
          "type": "array",
          "description": "A list of ingestible exchange mailboxes to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleExchangeMailbox"
          }
        },
        "s3Buckets": {
          "type": "array",
          "description": "A list of ingestible S3 buckets to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleS3Bucket"
          }
        },
        "sqlServers": {
          "type": "array",
          "description": "A list of ingestible SQL servers to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleSQLServer"
          }
        },
        "oracleServers": {
          "type": "array",
          "description": "A list of ingestible Oracle servers to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleOracleServer"
          }
        },
        "enterpriseVaults": {
          "type": "array",
          "description": "A list of ingestible enterprise vaults to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleEnterpriseVault"
          }
        },
        "sharepointSites": {
          "type": "array",
          "description": "A list of ingestible sharepoint sites to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleSharepoint"
          }
        },
        "mailStores": {
          "type": "array",
          "description": "A list of ingestible mail stores to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleMailStore"
          }
        },
        "loadFiles": {
          "type": "array",
          "description": "A list of ingestible load files to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleLoadFile"
          }
        },
        "centeraClusters": {
          "type": "array",
          "description": "A list of ingestible centera clusters to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleCenteraCluster"
          }
        },
        "splitFiles": {
          "type": "array",
          "description": "A list of ingestible split files to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleSplitFileList"
          }
        },
        "dropboxes": {
          "type": "array",
          "description": "A list of ingestible Dropbox accounts to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleDropbox"
          }
        },
        "sshServers": {
          "type": "array",
          "description": "A list of SSH-based servers to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleSSH"
          }
        },
        "twitterLocations": {
          "type": "array",
          "description": "A list of historical twitter locations to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleTwitter"
          }
        },
        "documentumServers": {
          "type": "array",
          "description": "A list of documentum servers to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleDocumentum"
          }
        },
        "ms365Locations": {
          "type": "array",
          "description": "A list of Microsoft 365 locations to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleMicrosoft365"
          }
        },
        "slackLocations": {
          "type": "array",
          "description": "A list of slack locations to ingest.",
          "items": {
            "$ref": "#/$defs/IngestibleSlack"
          }
        }
      }
    },
    "EvidenceRepository": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "description": "The path of the evidence repository folder. Each folder or file immediately inside this path will become a new evidence container."
        },
        "custodianLevel": {
          "type": "integer",
          "description": "If custodian names are present in the repository, this is a positive integer of the number of folder levels nesting inside the repository where custodians are defined. For example custodianLevel = 1 indicates that each folder immediately inside the repository folder is a custodian name, while custodianLevel = 2 indicates that each folder nested two levels inside the repository folder is a custodian name. If the repository does not contain custodian names then this parameter can be either omitted or set to -1.",
          "default": -1,
          "format": "int32"
        },
        "evidenceContainerNaming": {
          "type": "string",
          "enum": [
            "content",
            "numbered"
          ],
          "default": "content",
          "description": "If \"content\" then evidence containers created from folders or files in the evidence repository will take their name from those folders and files (this was the only behaviour prior to Nuix 6.2), if \"numbered\" then evidence containers will be given sequentially numbered names instead."
        },
        "evidenceContainerNamingPrefix": {
          "type": "string",
          "description": "If not null then all evidence containers created will have the given prefix appended to the beginning of their name. For example to obtain Nuix's default evidence naming scheme of \"Evidence 1\", \"Evidence 2\", \"Evidence 3\", etc you would use evidenceContainerNamingPrefix=\"Evidence \",evidenceContainerNaming=\"numbered\" (note the trailing space in the prefix string)."
        },
        "timeZone": {
          "type": "string",
          "description": "Sets the repository time zone."
        },
        "charset": {
          "type": "string",
          "description": "Sets the repository character set."
        },
        "language": {
          "type": "string",
          "description": "Sets the repository language."
        },
        "countryCode": {
          "type": "string",
          "description": "Sets the repository country code."
        }
      }
    },
    "IngestibleCenteraCluster": {
      "type": "object",
      "properties": {
        "ipsFile": {
          "type": "string",
          "description": "Location of a file containing IP addresses separated by new-line characters. Both File and String instances are supported."
        },
        "clipsFile": {
          "type": "string",
          "description": "Location of a file containing Centera Clip IDs separated by new-line characters. Both File and String instances are supported."
        }
      }
    },
    "IngestibleDocumentum": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "This optional parameter defines the Windows networking domain of the server account."
        },
        "username": {
          "type": "string",
          "description": "The username needed to access the server account."
        },
        "password": {
          "type": "string",
          "description": "The password needed to access the server account."
        },
        "port": {
          "type": "integer",
          "description": "The port number",
          "default": 1489
        },
        "query": {
          "type": "string",
          "description": "This optional parameter specifies a DQL (documentum) query used to filter the content."
        },
        "server": {
          "type": "string",
          "description": "This parameter specifies the Documentum server address."
        },
        "docBase": {
          "type": "string",
          "description": "This parameter specifies the Documentum docbase repository."
        },
        "propertyFile": {
          "type": "string",
          "description": "This optional parameter specifies the Documentum property file."
        }
      }
    },
    "IngestibleDropbox": {
      "type": "object",
      "properties": {
        "authCode": {
          "type": "string",
          "description": "A string retrieved via a webpage on Dropbox that enables access to an account. The account credentials are provided only to Dropbox. To get the URL pass dropbox without this parameter, then get the authCode by following the instructions at the URL provided in the MissingAccessTokenException and invoke this method again using the retrieved authCode parameter. These codes have an expiry time of the order of minutes."
        },
        "team": {
          "type": "boolean",
          "description": "Whether or not a Dropbox team is being ingested.  This optional parameter should be present and set to true for all invocations when adding a Dropbox team to evidence. It can be omitted to add an individual Dropbox account."
        },
        "accessToken": {
          "type": "string",
          "description": "A string retrieved using the authCode that enables access to an account. For dropbox, if the access token to an account is already known, provide it directly using this parameter instead of authCode. This code doesn't expire unless the account owner revokes access for Nuix."
        }
      }
    },
    "IngestibleEnterpriseVault": {
      "type": "object",
      "properties": {
        "computer": {
          "type": "string",
          "description": "The hostname or IP address of the target server."
        },
        "from": {
          "type": "string",
          "description": "This optional parameter limits the evidence to a date range beginning from the specified date/time. It must be accompanied by the 'to' parameter. Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server.",
          "format": "date-time"
        },
        "to": {
          "type": "string",
          "description": "This optional parameter limits the evidence to a date range ending at the specified date/time. It must be accompanied by the 'from' parameter.  Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server.",
          "format": "date-time"
        },
        "vault": {
          "type": "string",
          "description": "This optional parameter limits the evidence to the specified Enterprise Vault vault."
        },
        "archive": {
          "type": "string",
          "description": "This optional parameter limits the evidence to the specified Enterprise Vault archive."
        },
        "custodian": {
          "type": "string",
          "description": "This optional parameter limits the evidence to the specified custodian or author."
        },
        "keywords": {
          "type": "string",
          "description": "This optional parameter limits the evidence to results matching Enterprise Vault's query using the words in this string. Subject and message/document content are searched by Enterprise Vault and it will match any word in the string unless specified differently in the flag parameter."
        },
        "flag": {
          "type": "string",
          "description": "This optional parameter specifies how keywords are combined and treated for keyword-based queries. It must be accompanied by the 'keywords' parameter but will default to any if it is omitted. A value from any, all, allnear, phrase, begins, beginany, exact, exactany, ends, endsany."
        }
      }
    },
    "IngestibleExchangeMailbox": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "The username needed to access the server account."
        },
        "password": {
          "type": "string",
          "description": "The password needed to access the server account."
        },
        "uri": {
          "type": "string",
          "description": "Protocol, host, port and path can all be specified. For SharePoint the address is the site address. For Exchange the address is the path to the Exchange Web Service (e.g., https://ex2010/ews/exchange.asmx) and it can be omitted to use auto-discovery based on the mailbox or username address."
        },
        "domain": {
          "type": "string",
          "description": "This optional parameter defines the Windows networking domain of the server account."
        },
        "to": {
          "type": "string",
          "description": "This optional parameter limits the evidence to a date range ending at the specified date/time. It must be accompanied by the 'from' parameter. Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server.",
          "format": "date-time"
        },
        "from": {
          "type": "string",
          "description": "This optional parameter limits the evidence to a date range beginning from the specified date/time. It must be accompanied by the 'to' parameter. Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server.",
          "format": "date-time"
        },
        "mailbox": {
          "type": "string",
          "description": "The mailbox (specified by email address) to ingest if it differs from the username."
        },
        "impersonating": {
          "type": "boolean",
          "description": "Instructs Exchange to impersonate the mailbox user instead of delegating when the mailbox and username are different. Defaults to false."
        },
        "mailboxRetrieval": {
          "type": "array",
          "description": "A list containing one or more of the following string values: mailbox, archive, purges, deletions, recoverable_items, archive_purges, archive_deletions, archive_recoverable_items, public_folders. Determines whether to extract from the user's mailbox, archive, recoverable items.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "IngestibleFile": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string",
          "description": "Absolute path to the directory or file to be ingested."
        }
      },
      "required": [
        "path"
      ]
    },
    "IngestibleLoadFile": {
      "type": "object",
      "properties": {
        "csvFile": {
          "type": "string",
          "description": "Location of a UTF-8 encoded CSV file containing an ITEMPATH column with values containing relative paths to the native items. Currently all other columns become metadata for that item. Not used if missing, but one load file type is required."
        },
        "idxFile": {
          "type": "string",
          "description": "Location of a UTF-8 encoded IDX file. Not used if missing, but one load file type is required."
        }
      }
    },
    "IngestibleMailStore": {
      "type": "object",
      "properties": {
        "protocol": {
          "type": "string",
          "description": "Mailstore protocol, supported values: pop, pops, imap, imaps, gwta."
        },
        "host": {
          "type": "string",
          "description": "The host server IP or hostname."
        },
        "port": {
          "type": "integer",
          "description": "The port number.",
          "format": "int32"
        },
        "username": {
          "type": "string",
          "description": "The username for the mail store."
        },
        "password": {
          "type": "string",
          "description": "The password."
        }
      }
    },
    "IngestibleMicrosoft365": {
      "type": "object",
      "properties": {
        "tenantId": {
          "type": "string",
          "description": "The tenant ID for the Azure Active Directory tenant."
        },
        "clientId": {
          "type": "string",
          "description": "The client/application ID for an app that has been registered with your Azure Active Directory tenant and granted the necessary privileges."
        },
        "clientSecret": {
          "type": "string",
          "description": "The client secret that has been configured for the clientId provided, for authentication."
        },
        "username": {
          "type": "string",
          "description": "The optional username for a user that is a member of the Teams to be processed, only needed for ingesting Team Calendars."
        },
        "password": {
          "type": "string",
          "description": "The password for the username if it is present."
        },
        "certificateStorePath": {
          "type": "string",
          "description": "The path to a PKCS#12 certificate store, usable instead of clientSecret for authentication."
        },
        "certificateStorePassword": {
          "type": "string",
          "description": "The password to the PKCS#12 certificate store."
        },
        "from": {
          "type": "string",
          "format": "date-time",
          "description": "Sets the start date on the location. The start date and end date are both required, and if retrievals(Collection) includes USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years.  Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server."
        },
        "to": {
          "type": "string",
          "format": "date-time",
          "description": "Sets the end date on the location. The start date and end date are both required, and if retrievals(Collection) includes USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years.  Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server."
        },
        "retrievals": {
          "type": "array",
          "description": "Sets the content to be retrieved from Microsoft Graph. Available options are TEAMS_CHANNELS, TEAMS_CALENDARS, USERS_CHATS, USERS_CONTACTS, USERS_CALENDARS, USERS_EMAILS, ORG_CONTACTS, SHAREPOINT",
          "items": {
            "type": "string",
            "enum": [
              "TEAMS_CHANNELS",
              "TEAMS_CALENDARS",
              "USERS_CHATS",
              "USERS_CONTACTS",
              "USERS_CALENDARS",
              "USERS_EMAILS",
              "ORG_CONTACTS",
              "SHAREPOINT"
            ]
          }
        },
        "mailFolderRetrievals": {
          "type": "array",
          "description": "Sets the mail folder retrieval areas for Exchange Online.",
          "items": {
            "type": "string",
            "enum": [
              "ALL",
              "MAILBOX_ALL",
              "RECOVERABLE_ITEMS_ALL",
              "ARCHIVE",
              "CLUTTER",
              "CONVERSATION_HISTORY",
              "DELETED_ITEMS",
              "DRAFTS",
              "INBOX",
              "JUNK",
              "OUTBOX",
              "SENT_ITEMS",
              "SYNC_ISSUES",
              "OTHER",
              "RECOVERABLE_ITEMS_DELETIONS",
              "RECOVERABLE_ITEMS_PURGES",
              "RECOVERABLE_ITEMS_DISCOVERY_HOLDS",
              "RECOVERABLE_ITEMS_SUBSTRATE_HOLDS",
              "RECOVERABLE_ITEMS_OTHER"
            ]
          }
        },
        "mailboxRetrievals": {
          "type": "array",
          "deprecated": true,
          "description": "list of possible areas to retrieve from. Defaults to [ \"MAILBOX\" ]. Possible values MAILBOX, ARCHIVE, PURGES, DELETIONS, RECOVERABLE_ITEMS, ARCHIVE_PURGES, ARCHIVE_DELETIONS, ARCHIVE_RECOVERABLE_ITEMS, PUBLIC_FOLDERS.",
          "default": [
            "MAILBOX"
          ],
          "items": {
            "type": "string",
            "enum": [
              "MAILBOX",
              "ARCHIVE",
              "PURGES",
              "DELETIONS",
              "RECOVERABLE_ITEMS",
              "ARCHIVE_PURGES",
              "ARCHIVE_DELETIONS",
              "ARCHIVE_RECOVERABLE_ITEMS",
              "PUBLIC_FOLDERS"
            ]
          }
        },
        "teamNames": {
          "type": "array",
          "description": "Sets the team names on the location.",
          "items": {
            "type": "string"
          }
        },
        "userPrincipalNames": {
          "type": "array",
          "description": "Sets the user principal names on the location.",
          "items": {
            "type": "string"
          }
        },
        "versionFilters": {
          "$ref": "#/$defs/Microsoft365VersionFilterOptions"
        },
        "licenseModel": {
          "description": "The payment models and licensing requirements for Microsoft Teams APIs in Microsoft Graph.  If not provided, evaluation mode will be used.  Model 'A' is restricted to applications performing a security or compliance function.  Model 'B' is restricted to applications that don't perform a security or compliance function.  Please see https://learn.microsoft.com/en-us/graph/teams-licenses for more information regarding Microsoft Teams APIs.",
          "type": "string",
          "enum": [
            "A",
            "B"
          ]
        }
      },
      "required": [
        "tenantId",
        "clientId",
        "from",
        "to"
      ]
    },
    "IngestibleOracleServer": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "The username needed to access the server account."
        },
        "password": {
          "type": "string",
          "description": "The password needed to access the server account."
        },
        "database": {
          "type": "string",
          "description": "The hostname or IP address of the database server."
        },
        "query": {
          "type": "string",
          "description": "This optional parameter specifies the SQL query used to filter the content."
        },
        "driverType": {
          "type": "string",
          "description": "This parameter specifies the driver type. See www.oracle.com",
          "enum": [
            "thin",
            "oci",
            "kprb"
          ]
        },
        "role": {
          "type": "string",
          "description": "A string representation of the role to login as, such as SYSDBA or SYSOPER.  For normal logins, this should be blank."
        },
        "maxRowsPerTable": {
          "type": "integer",
          "description": "The maximum number of rows to return from each table or query.  This parameter is optional. It can save time when processing tables or query results with very many rows. The selection of which rows will be returned should be considered arbitrary.",
          "format": "int32"
        }
      }
    },
    "IngestibleS3Bucket": {
      "type": "object",
      "properties": {
        "access": {
          "type": "string",
          "description": "This parameter specifies the access key ID for an Amazon Web Service account."
        },
        "secret": {
          "type": "string",
          "description": "This parameter specifies the secret access key for an Amazon Web Service account."
        },
        "bucket": {
          "type": "string",
          "description": "This optional parameter specifies a bucket and optionally a path to a folder within the bucket that contains the evidence to ingest. For example, 'com.nuix.mybucket/top folder/sub folder'. Omitting this parameter will cause all buckets to be added to evidence."
        },
        "endpoint": {
          "type": "string",
          "description": "This optional parameter specifies a particular Amazon Web Service server endpoint. This can be used to connect to a particular regional server e.g., https://s3.amazonaws.com."
        },
        "useCredentialDiscovery": {
          "type": "boolean",
          "description": "Use credential discovery instead of anonymous access."
        }
      }
    },
    "IngestibleSQLServer": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "This optional parameter defines the Windows networking domain of the server account."
        },
        "username": {
          "type": "string",
          "description": "The username needed to access the server account."
        },
        "password": {
          "type": "string",
          "description": "The password needed to access the server account."
        },
        "computer": {
          "type": "string",
          "description": "The hostname or IP address of the target server."
        },
        "instance": {
          "type": "string",
          "description": "This parameter specifies the database instance."
        },
        "query": {
          "type": "string",
          "description": "This optional parameter specifies the SQL query used to filter the content."
        },
        "maxRowsPerTable": {
          "type": "integer",
          "description": "The maximum number of rows to return from each table or query.  This parameter is optional. It can save time when processing tables or query results with very many rows. The selection of which rows will be returned should be considered arbitrary."
        }
      }
    },
    "IngestibleSSH": {
      "type": "object",
      "properties": {
        "username": {
          "type": "string",
          "description": "The username needed to access the server account."
        },
        "password": {
          "type": "string",
          "description": "The password needed to access the server account."
        },
        "computer": {
          "type": "string",
          "description": "The hostname or IP address of the target server."
        },
        "sudoPassword": {
          "type": "string",
          "description": "The password needed to access protected files when using SSH key based authentication."
        },
        "keyFolder": {
          "type": "string",
          "description": "Points to a folder on the local system which holds the SSH authentication key pairs."
        },
        "portNumber": {
          "type": "integer",
          "description": "The port number to connect on.",
          "format": "int32"
        },
        "hostFingerprint": {
          "type": "string",
          "description": "The expected host fingerprint for the host being connected to. If this value is not set then any host fingerpint will be allowed, leaving the possibility of a man in the middle attack on the connection."
        },
        "remoteFolder": {
          "type": "string",
          "description": "This optional parameter limits the evidence to items underneath this starting folder."
        },
        "accessingRemoteDisks": {
          "type": "boolean",
          "description": "When set to true remote disks (e.g. '/dev/sda1') will be exposed as evidence instead of the remote system's file system structure."
        },
        "initialLocation": {
          "type": "string",
          "description": "Sets the location to use local disks with initial location."
        }
      }
    },
    "IngestibleSharepoint": {
      "type": "object",
      "properties": {
        "domain": {
          "type": "string",
          "description": "This optional parameter defines the Windows networking domain of the server account."
        },
        "username": {
          "type": "string",
          "description": "The username needed to access the server account."
        },
        "password": {
          "type": "string",
          "description": "The password needed to access the server account."
        },
        "uri": {
          "type": "string",
          "description": "Protocol, host, port and path can all be specified. For SharePoint the address is the site address.  It can be omitted to use auto-discovery based on site address."
        }
      }
    },
    "IngestibleSlack": {
      "type": "object",
      "properties": {
        "tempAuthCode": {
          "type": "string",
          "description": "The temporary authorization code obtained from Slack's OAuth flow. Not required if storedCredentialName is provided."
        },
        "storedCredentialName": {
          "type": "string",
          "description": "The name of the slack credentials stored in credentials store. Not required if tempAuthCode is provided."
        },
        "from": {
          "type": "string",
          "format": "date-time",
          "description": "Sets the start date on the location. The start date and end date are both required, and if retrievals(Collection) includes USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years.  Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server."
        },
        "to": {
          "type": "string",
          "format": "date-time",
          "description": "Sets the end date on the location. The start date and end date are both required, and if retrievals(Collection) includes USERS_CALENDARS or TEAMS_CALENDARS, then the date range cannot exceed five years.  Accepted date formats are RFC-3339 or a simple date format (yyyy-MM-dd) which will use the default timezone of the server."
        },
        "userIds": {
          "type": "array",
          "description": "The Set of user IDs to filter Slack messages and files from.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "IngestibleSplitFileList": {
      "type": "object",
      "properties": {
        "files": {
          "type": "array",
          "description": "The list of files to add. Absolute paths are recommended.",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "IngestibleTwitter": {
      "type": "object",
      "properties": {
        "accessToken": {
          "type": "string",
          "description": "The access token of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already."
        },
        "accessTokenSecret": {
          "type": "string",
          "description": "The access token secret of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already."
        },
        "consumerKey": {
          "type": "string",
          "description": "The consumer key (API key) of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already."
        },
        "consumerSecret": {
          "type": "string",
          "description": "The consumer secret (API secret) of your twitter app. You can create a new app at https://apps.twitter.com and generate this if you don't have one already."
        }
      }
    },
    "KeyStoreKeyParameters": {
      "type": "object",
      "properties": {
        "filePassword": {
          "type": "string",
          "description": "Specifies the password protecting the file (e.g. for PKCS#12)"
        },
        "keyPasswords": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Specifies the passwords protecting individual keys when extracting multiple password-protected keys from a single file."
        },
        "target": {
          "type": "string",
          "description": "For Lotus Notes ID files, this value should contain the file name of the NSF file protected by this key."
        },
        "keystoreName": {
          "type": "string",
          "description": "The name of the keystore file being used."
        }
      }
    },
    "Microsoft365VersionFilterOptions": {
      "type": "object",
      "description": "The version filter options.",
      "properties": {
        "versionRetrievalEnabled": {
          "type": "boolean",
          "description": "True if all versions should be retrieved, false for current version only.",
          "default": false
        },
        "versionRetrievalLimit": {
          "type": "integer",
          "description": "Integer value limiting the number of versions retrieved if versionRetrievalEnabled is set to true.  -1 (all available versions)"
        }
      }
    },
    "MimeTypeProcessingSetting": {
      "type": "object",
      "properties": {
        "mimeType": {
          "type": "string",
          "description": "Sets the MIME type"
        },
        "settings": {
          "$ref": "#/$defs/MimeTypeSpecificProcessingSettings"
        }
      }
    },
    "MimeTypeSpecificProcessingSettings": {
      "type": "object",
      "properties": {
        "enabled": {
          "type": "boolean",
          "description": "Controls whether items matching this MIME type, and their embedded descendants, will be processed.  Default is true"
        },
        "processEmbedded": {
          "type": "boolean",
          "description": "Controls whether embedded descendants matching this MIME type will be processed.  Default is true"
        },
        "processText": {
          "type": "boolean",
          "description": "Controls whether items matching this MIME type will have their text processed.  This setting takes precedence over 'textStrip' if both are set to true.  Set this and 'textStrip' to false in order to skip text processing.  Default is true"
        },
        "textStrip": {
          "type": "boolean",
          "description": "Controls whether items matching this MIME type will have their binary data text stripped.  Set this and 'processText' to false in order to skip text processing.  Default is false"
        },
        "processNamedEntities": {
          "type": "boolean",
          "description": "Controls whether items matching this MIME type will have their named entities processed. This setting only takes effect if either 'extractNamedEntitiesFromText' or 'extractNamedEntitiesFromProperties' is enabled in 'ProcessorSettings'. Default is true"
        },
        "processImages": {
          "type": "boolean",
          "description": "Controls whether items matching this MIME type will have their image data processed. This setting only takes effect if 'createThumbnails' is enabled in 'ProcessorSettings'.  Default is true"
        },
        "storeBinary": {
          "type": "boolean",
          "description": "Controls whether items matching this MIME type will have their binary data stored.  This setting only takes effect if 'storeBinary' is enabled in 'ProcessorSettings'.  Default is true"
        }
      }
    },
    "NamedEntity": {
      "type": "object",
      "properties": {
        "regularExpression": {
          "type": "string",
          "description": "Gets the regular expression used by the entity."
        },
        "name": {
          "type": "string",
          "description": "Gets the name of the entity."
        }
      }
    },
    "ParallelProcessingSettings": {
      "type": "object",
      "properties": {
        "workerCount": {
          "type": "integer",
          "description": "Number of worker processes to use. This defaults to number of CPU cores on the machine. This value is also limited by settings in the current licence / session.",
          "format": "int32"
        },
        "workerMemory": {
          "type": "integer",
          "description": "Maximum amount of memory to allocate to each worker process in megabytes. The provided value must be >= 768. Default is calculated based on the number of workers and available machine memory.",
          "format": "int32"
        },
        "workerTemp": {
          "type": "string",
          "description": "Base directory that workers will use to store temporary files generated during process. Can be a string file path, File, Path or URI. The default is a directory under the case directory."
        },
        "embedBroker": {
          "type": "boolean",
          "description": "If true, the JMS broker will be run within the current process,otherwise it will be run in a new process. Default is true.",
          "default": true
        },
        "brokerMemory": {
          "type": "integer",
          "description": "Amount of memory to allocate to the JMS broker when it is run in a separate process. The provided value must be &gt;= 768. Default is 4096.",
          "format": "int32",
          "default": 4096
        },
        "workerBrokerAddress": {
          "type": "string",
          "description": "Worker broker address in the format host:port. "
        },
        "useRemoteWorkers": {
          "description": "True to use remote workers when possible, false otherwise.",
          "type": "boolean",
          "default": false
        }
      }
    },
    "PasswordDiscoverySettings": {
      "type": "object",
      "properties": {
        "mode": {
          "type": "string",
          "description": "Sets password discovery settings to use for encrypted items.",
          "enum": [
            "none",
            "word_list"
          ]
        },
        "wordList": {
          "type": "string",
          "description": "The name of a word list accessible in the system. If the mode is set to \"word-list\", then this word-list will be used as the basis for password discovery"
        }
      }
    },
    "ProcessorSettings": {
      "type": "object",
      "properties": {
        "processText": {
          "type": "boolean",
          "description": "If true, stores and indexes the text of data items.  Default is true.",
          "default": true
        },
        "traversalScope": {
          "type": "string",
          "description": "Selects the traversal scope for ingestion.\n* `full_traversal` - Processes all items and their descendants during processing except where specific MIME type settings apply.\n* `loose_files` - Processes loose files but not their contents.\n* `loose_files_and_forensic_images` - Processes loose files and forensic images but not their contents. This can be used to 'explode' forensic\n  images without processing all the files inside. Note: `identifyPhysicalFiles` must be set to true to explode forensic images.\n",
          "enum": [
            "full_traversal",
            "loose_files",
            "loose_files_and_forensic_images"
          ]
        },
        "processLooseFileContents": {
          "type": "boolean",
          "description": "If true, the contents of loose files will be extracted and processed. If false metadata about loose files will be extracted but their contents will not be processed. Default is true. Deprecated in Nuix 7.0, eplaced with traversalScope.",
          "deprecated": true,
          "default": true
        },
        "processForensicImages": {
          "type": "boolean",
          "description": "If true, the contents of forensic images will be exposed. If false metadata about forensic images will be extracted but their contents will not be processed. This settings can be used in combination with processLooseFileContents to explode forensic images but not process their contents. Default is true. Deprecated in Nuix 7.0, replaced with traversalScope.",
          "deprecated": true,
          "default": true
        },
        "analysisLanguage": {
          "type": "string",
          "description": "Specifies the language to use for text analysis when indexing. A supported language code.  Example codes are: \"en\" - English, \"ja\" - Japanese. Default is \"en\".",
          "default": "en"
        },
        "stopWords": {
          "type": "boolean",
          "description": "If true, removes English stop words (\"a\", \"and\", \"the\", etc.) from the text index. If false, no stop words are removed. Default is false.",
          "default": false
        },
        "stemming": {
          "type": "boolean",
          "description": "If true, stems words using English rules before indexing (e.g. \"fishing\" -> \"fish\".). If false, no stemming is performed. Default is false.",
          "default": false
        },
        "enableExactQueries": {
          "type": "boolean",
          "description": "If true, enables search using \"exact\" queries.  Default is false.",
          "default": false
        },
        "extractNamedEntities": {
          "type": "boolean",
          "description": "If true, extract named entities from the text of a document.  Default is false. NOTE: This is deprecated and will be removed in future release.  Deprecated in Nuix 6.0.",
          "deprecated": true,
          "default": false
        },
        "extractNamedEntitiesFromText": {
          "type": "boolean",
          "description": "If true, extracts named entities from the text of a document.  Default is false",
          "default": false
        },
        "extractNamedEntitiesFromProperties": {
          "type": "boolean",
          "description": "If true, extracts named entities from the properties of a document.  Default is false",
          "default": false
        },
        "extractNamedEntitiesFromTextStripped": {
          "type": "boolean",
          "description": "If true, extracts named entities from the text of text-stripped items, if and only if 'extractNamedEntitesFromText' is true. The 'extractNamedEntitiesFromProperties' setting is independent of this property.  Default is false",
          "default": false
        },
        "extractNamedEntitiesFromTextCommunications": {
          "type": "boolean",
          "description": "If true, extract named entities from the communication metadata of a document.  Default is false.",
          "default": false
        },
        "extractShingles": {
          "type": "boolean",
          "description": "If true, extract shingles from item text. Enabling this setting enables near deduplication.  Default is true.",
          "default": true
        },
        "processTextSummaries": {
          "type": "boolean",
          "description": "If true, process item text and summarise.  Default is true.",
          "default": true
        },
        "calculateSSDeepFuzzyHash": {
          "type": "boolean",
          "description": "If true, calculate SSDeep fuzzy hash values for item. Default is false.",
          "default": false
        },
        "calculatePhotoDNARobustHash": {
          "type": "boolean",
          "description": "If true, calculate PhotoDNA robust hash values for image items.",
          "default": false
        },
        "detectFaces": {
          "type": "boolean",
          "description": "If true, detect faces in photographic items. Default is false.",
          "default": false
        },
        "classifyImagesWithDeepLearning": {
          "type": "boolean",
          "description": "If true, classify images using Deep Learning. Requires additional following settings: imageClassificationModelUrl. Default is false.",
          "default": false
        },
        "imageClassificationModelUrl": {
          "type": "string",
          "description": "URL pointing to Deep Learning model - can be a local file too, but in URL format (file://path/to/model)."
        },
        "extractFromSlackSpace": {
          "type": "boolean",
          "description": "If true, extract deleted data from mailbox file formats and slack space from the end of file records in file system disk images.  Default is false.",
          "default": false
        },
        "carveFileSystemUnallocatedSpace": {
          "type": "boolean",
          "description": "If true, carve data out of file system unallocated space for disk images.  Default is false.",
          "default": false
        },
        "carveUnidentifiedData": {
          "type": "boolean",
          "description": "If true, carve data out of unidentified data items.  Default is false.",
          "default": false
        },
        "carvingBlockSize": {
          "type": "integer",
          "description": "If null, the block size of the file system is used. Otherwise the given block size is used. File identification is attempted at start of each block, so the smaller the value the longer processing will take. Avoid values smaller than 512 bytes except in specific cases. Default is null.",
          "format": "int32"
        },
        "recoverDeletedFiles": {
          "type": "boolean",
          "description": "If true, recover deleted file records from disk images.  Default is true.",
          "default": true
        },
        "extractEndOfFileSlackSpace": {
          "type": "boolean",
          "description": "If true, extract the slack space from the end of file records in disk images.  Default is false.",
          "default": false
        },
        "smartProcessRegistry": {
          "type": "boolean",
          "description": "If true, only process sections of the Registry that have decoders of have been explicitly selected. Default is false",
          "default": false
        },
        "identifyPhysicalFiles": {
          "type": "boolean",
          "description": "If false, only file system metadata is extracted for physical files on disk.  Default is true.",
          "default": true
        },
        "createThumbnails": {
          "type": "boolean",
          "description": "If true, create and store thumbnails of image data items.  Default is true.",
          "default": true
        },
        "skinToneAnalysis": {
          "type": "boolean",
          "description": "If true, perform analysis on images to detect skintones.  Default is false.",
          "default": false
        },
        "calculateAuditedSize": {
          "type": "boolean",
          "description": "If true, calculates audited size.  Default is false.",
          "default": false
        },
        "storeBinary": {
          "type": "boolean",
          "description": "If true, store the binary of data items.  Default is false.",
          "default": false
        },
        "maxStoredBinarySize": {
          "type": "integer",
          "description": "Specifies the maximum size of binary which will be stored into the binary store, in bytes. Default is 250000000 (250 MB).",
          "default": 250000000,
          "format": "int32"
        },
        "maxDigestSize": {
          "type": "integer",
          "description": "Specifies the maximum size of binary which will be digested, in bytes. Default is 250000000 (250 MB).",
          "default": 250000000,
          "format": "int64"
        },
        "digests": {
          "type": "array",
          "description": "A list of digests to calculate.  Valid values \"MD5\", \"SHA-1\" or \"SHA-256\".  Default is [ \"MD5\" ].",
          "default": [
            "MD5"
          ],
          "items": {
            "type": "string"
          }
        },
        "addBccToEmailDigests": {
          "type": "boolean",
          "description": "If true, adds the Bcc field when computing email digests. Using the Bcc field in email digests may prevent the sender and recipients digests from matching. This is because only the sender will have the Bcc field if it is present. Default is false.",
          "default": false
        },
        "addCommunicationDateToEmailDigests": {
          "type": "boolean",
          "description": "If true, adds the communication date when computing email digests. Using the communication date in the email digests may prevent the sender and recipients digests from matching. This is because the sender and recipients communication date / times can be slightly different for the same email. Default is false.",
          "default": false
        },
        "reuseEvidenceStores": {
          "type": "boolean",
          "description": "If true, existing evidence stores are used to add any additional data into.  Default is false.",
          "default": false
        },
        "processFamilyFields": {
          "type": "boolean",
          "description": "If true, top-level items will contain search fields containing text from their family.  Default is false.",
          "default": false
        },
        "hideEmbeddedImmaterialData": {
          "type": "boolean",
          "description": "If true, hides embedded immaterial data items such as embedded images in documents.  Default is false.",
          "default": false
        },
        "reportProcessingStatus": {
          "type": "string",
          "description": "If \"physical_files\", then the total evidence physical file size is calculated before processing starts. If \"none\", then no up-front calculation is performed. Non-file data will always be treated as \"none\". Default is none.",
          "default": "none"
        },
        "enableCustomProcessing": {
          "type": "array",
          "description": "Which aspects of the data to expose in the callback from whenItemProcessed(ItemProcessedCallback). They are accessible from ProcessedItem.getProperties(), ProcessedItem.getTextFile() and ProcessedItem.getBinaryFile() respectively. All other processing options will be skipped when this option is enabled.",
          "items": {
            "type": "string",
            "enum": [
              "properties",
              "binary",
              "text"
            ]
          }
        },
        "workerItemCallback": {
          "type": "string",
          "description": "A string prefixed with \"java:\" followed by the name of a class with a no argument constructor which implements Consumer<WorkerItem>, or the name of a scripting engine followed by a colon character follow by the script to execute. Example scripting engine names include \"ruby\", \"python\" and \"ecmascript\".  For scripting languages, this string is the actual script code."
        },
        "workerItemCallbacks": {
          "type": "array",
          "description": "A list of strings specifying worker scripts. See workerItemCallback for script details. Scripts are processed in list order.",
          "items": {
            "type": "string"
          }
        },
        "performOcr": {
          "type": "boolean",
          "description": "If true, performs the OCR on the items based on the selected OCR profile.  Default is false.",
          "default": false
        },
        "ocrProfileName": {
          "type": "string",
          "description": "This must be set to an OCR profile name that exists.",
          "default": "Default"
        },
        "createPrintedImage": {
          "type": "boolean",
          "description": "If true, creates a printed image for items based on an imaging profile.  Default is false.",
          "default": false
        },
        "imagingProfileName": {
          "type": "string",
          "description": "If createPrintedImage is set to true, this specifies the name of the imaging profile to use during processing. This must be set to the name of an existing imaging profile that can be reached within the current context.",
          "default": "Processing Default"
        },
        "exportMetadata": {
          "type": "boolean",
          "description": "If true, exports an item's metadata using a given metadata export profile.  Default is false.",
          "default": false
        },
        "metadataExportProfileName": {
          "type": "string",
          "description": "If exportMetadata is set to true, this specifies the name of the metadata export profile to use during processing. This must be set to the name of a metadata export profile that can be reached within the current context."
        },
        "namedEntities": {
          "type": "array",
          "description": "Passes in the list of named entities to be used in processing. If null, the default named entity settings are used.",
          "items": {
            "$ref": "#/$defs/NamedEntity"
          }
        }
      }
    },
    "RescanEvidenceRepositoriesSettings": {
      "type": "object",
      "description": "Settings when rescanning the case's evidence repositories.",
      "properties": {
        "depth": {
          "type": "integer",
          "description": "Maximum depth of directories to be rescanned.",
          "format": "int32"
        }
      }
    }
  }
}