Field | Required | Default | Multiple | Notes | Example | |
---|---|---|---|---|---|---|
type | Yes | - | No | The value must be "box". | "box" | |
description | Yes | - | No | Name of the credential object. | "Box Credential" | |
properties | Yes | - | No | Configuration object | ||
credentialType | Yes | basic | Type of authentication, basic or jwt | |||
ClientId | Yes | - | No | Only required if credentialType "basic" is selected.Box App Client Id | ||
ClientSecret | Yes | - | No | Only required if credentialType "basic" is selected.Box App Client Secret | ||
useJWT | Yes | false | No | Only required if credentialType "jwt" is selected.Indicates if we want to use JWT individual credentials | ||
jwtconfigdir | Yes | - | No | Only required if useJWT "false" is selected. Path of the JWT generated config file | ||
publicKeyID | Yes | - | Only required if useJWT "true" is selected. PublicKey ID from JWT | |||
privateKey | Yes | - | PrivateKey | Only required if useJWT "true" is selected. PrivateKey | ||
passphrase | passphrase | Yes | - | Only required if useJWT "true" is selected. Passphrase for the private key | ||
enterpriseID | Yes | - | Only required if useJWT "true" is selected. EnterpriseID of your Box Account | |||
Code Block | ||||
---|---|---|---|---|
| ||||
{ "typeid": "<Connector Type>2a5ca234-e328-4d40-bb2a-2df3e550b065", "description": "<Connector Name> Credential", "properties": { "domaincredentialType": "yourdomain.onmicrosoft.combasic" "appIDClientId": "sampleapplicationid6znlpe3l2xoknk1x1l35j029z4i5erty", "appSecretClientSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxx", } } #JWT - useJWT=false { "graphURLid": "https://graph.microsoft.com/v1.0" } } |
Field
Required
Default
Multiple
"OneDriveCredential"
Code Block | ||||
---|---|---|---|---|
| ||||
{ "id": "2a5ca234-e328-4d40-bb2a-2df3e550b0652a5ca234-e328-4d40-bb2a-2df3e550b065", "description": "<Connector Name> Credential", "properties": { "credentialType": "jwt" "useJWT": "false", "jwtconfigdir": "c:\\dev\\configJWT.json" } } #JWT - useJWT=true { "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065", "description": "<Connector Name> Credential", "description": "<Connector Name> Credential", "properties": { "credentialType": "basicjwt" "ClientIduseJWT": "avagdagahttrue", "ClientSecretpublicKeyID": "xxxxxxxxxxxxxxxxxxxxxxxxxx03a3i9xx" } } JWT { , "idprivateKey": "2a5ca234--e328-4d40-bb2a-2df3e550b065", BEGIN ENCRYPTED "description": "<Connector Name> Credential", "properties": { "credentialType": "jwt" "useJWT": "false", "jwtconfigdir": "c:\dev\configJWT.json" } } |
Field
Required
Default
Multiple
Example
PRIVATE KEY-----\nMIIFDjBABgkqhkiG9w0BBQ0wMzAbBgkqhkiG9w0BBQwwDgQIRC+Qx0nXyy8CAggA\nMBQGCCqGSIb3DQMHBAiTStLdrQuFWQSCBMgK7yKqHMnOT2Kyn
RTKRpm8/fJwKHDc\nuOOwAvZbeseVjF2MXxzEarLrs5xHbF5C4MwOzyAbRoc+Lu1ekLESPNg9n5r51opH\n5ZmanhlYKKKpTv3bZh8OPRC/pKyWkVY62UxRIA+g0kb6ZGPM2MTGQ7zseFeceuuC\nu6ZEN6Nl166
LgGfgUqpUUV01aGOGxN/zWJkTe5PBL2LydYK9HeTNgFgD24l+aCTU\nyOMJqZ0P+mdUdZKO7uEzwGOzR7MK8EKAg6++JBzz8k2uyWSKJpLLN+Z0ro7Ih9jy\nM0cEMI1T7/E6eH0rbtMbR+3MDz1GaJPCjdan5EYv
YCtHeK7kBb0InHVBPY6ps2HT\nFesaBdN4iJrPNlpKg6TnEjhE5IhS04WqmyfSW9JCKD/K0HsH3cYQ8DevJE+c0BYX\nOiP3ZBxgrOdvR9BCGv6kCgOEqSJYnBcljvJfOf8hS+kEBEPEst8g+EoR+zj91yD4\n
ftTscwNe35buNrthAUtO7g18UcnaFrQ43h/y0tqTofQ1HVMMoWXt/VIFKb3+0lZd\nSLPCFBYhSgWNm64/Hq8p+8hsBvhbKhBLCtTzpeXQ2pX\nwtQ=\n-----END ENCRYPTED PRIVATE KEY-----\n",
"passphrase":"7ce354e5dd8a5fad95852616addd3b61",
"enterpriseID":"512122"
}
} |
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
type | Yes | - | No | The value must be box | box |
description | Yes | - | No | Name of the connection object. | "MyBoxConnection" |
server | Yes | https://app.box.com | URL for Box server | ||
serverApi | Yes | https://api.box.com | URL for Box server API | ||
apiVersion | Yes | 2.0 | Box api version | ||
pageSize | No | 10 | Page for pagination of the files and folders | ||
stopScanError | No | false | Stop scan on error | ||
scanExcludedItems | No | false | Scan excluded items or folders | ||
credential | Yes | - | No | ID of the credential that applies to this connection object. | " |
The value must be OneDrive
onedrive
"MyOne DriveConnection"
theme | RDark |
---|---|
title | POST aspire/_api/connections |
d42e1872-02c8-4a90-a714-44f15577389a" |
throttlePolicy | No | - | No | ID of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The IDs of the routing policies that this connection will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
properties | Yes | - | No | Configuration object | |
---|---|---|---|---|---|
indexContainers | No | false | No | Select if containers are to be indexed. Clear to index files only. | TRUE |
scanRecursively | No | true | No | Select if subfolders are to be scanned. | TRUE |
scanExcludedItems | No | false | No | Select so that the scanner will scan sub items of container items excluded by a pattern | FALSE |
includes | No | - | Yes | List of regex URL patterns to include | [{"include":".*tmp[^/]$"} |
] | |||||
excludes | No | - | Yes | List of regex URL patterns to exclude | [{"include":".*tmp[^/]$"}] |
Code Block | ||||
---|---|---|---|---|
| ||||
{ "type": ]"box", "credential": "d42e1872-02c8-4a90-a714-44f15577389a", } } |
Field
Required
Default
Multiple
Notes
Example
"MyConnection"
Code Block | ||
---|---|---|
| ||
{ "id": "89d6632a-a296-426c-adb0-d442adcab4b0", "type": "onedrive", "credential": "d42e1872-02c8-4a90-a714-44f15577389a", "throttlePolicy": "", "routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "description": "<Connector Name> Test Connector", "properties": {"throttlePolicy": "", "routingPolicies": ["5c7274ef-429b-46ef-8f73-f010e479a467", "9dee4fba-14f2-4afc-a74d-297bcbbd359a"], "description": "<Connector Name> Test Connector", "properties": { "server":"https:\/\/app.box.com", "serverApi":"https:\/\/api.box.com", "apiVersion":"2.0", "pageSize":10, "stopScanError":false "indexContainers": true, "scanRecursively": true, "scanExcludedItems": false, "includes": [ {"include": ".*tmp[^/]$"} ], "indexContainersexcludes": true,[ {"scanRecursivelyexclude": true,".*jpg[^/]$"} "scanExcludedItems": false,] "includes": [ {"include": ".*tmp[^/]$"} ], "excludes": [ {"exclude": ".*tmp[^/]$"} ] } }} } |
For the creation of the Connector object using the Rest API, please refer to this page.
Field
Required
Default
Multiple
Notes
Example
The value must be one-drive.
onedrive
"My OneDrive Seed"
Field | Required | Default | Multiple | Notes | Example |
---|---|---|---|---|---|
seed | Yes | - | No | <seed description> | |
type | Yes | - | No | The value must be box. | box |
description | Yes | - | No | Name of the seed object. | "My Box Seed" |
connector | Yes | - | No | The ID of the connector to be used with this seed. The connector type must match the seed type. | "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31" |
connection | Yes | - | No | The ID of the connection to be used with this seed. The connection type must match the seed type. | "602d3700-28dd-4a6a-8b51-e4a663fe9ee6" |
workflows | No | [ ] | Yes | The IDs of the workflows that will be executed for the documents crawled. | ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"] |
throttlePolicy | No | - | No | ID of the throttle policy that applies to this connection object. | "f5587cee-9116-4011-b3a9-6b235b333a1b" |
routingPolicies | No | [ ] | Yes | The IDs of the routing policies that this seed will use. | ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"] |
tags | No | [ ] | Yes | The tags of the seed. These can be used to filter the seed. | ["tag1", "tag2"] |
properties | Yes | - | No | Configuration object | |
seed | Yes | - | No | This value must be box_seed | "box_seed" |
impersonate | Yes | all | No | Indicates that all Box users will be impersonated to get all their content | |
impersonate | Yes | specific | No | Indicates that specific list of Box users will be impersonated to get all their content | |
ImpersonatingUsers | Yes | Yes | List of users to impersonate | ||
userLogin | Yes | User login to impersonate (array of users login) | [{"userLogin": "[email protected]"},{"userLogin": "[email protected]"}] | ||
shouldBackoff | No | false | No | Select this option if the connection to the server throws an error for a backoff to be done | true |
backoffMinutes | Yes | - | Yes | Only required if shouldBackoff is "true". Time to wait when a backoff error is encountered. | 5 |
backoffRetries | No | - | No | Only required if shouldBackoff is "true". Number of retries with backoff when error is encountered | 2 |
excludeSubFolders | No | false | Select this option if there are folders to exclude from crawl. | ||
folder | No | - | No | Only required if excludeSubFolders is "true".Specify folder's name to exclude | "config/userNames.txt" |
Code Block | ||||
---|---|---|---|---|
| ||||
# LIST
{
"type": "<Connector Type>",
"seed": "box_seed",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag1", "tag2"],
"properties": {
"seed":"box_seed",
"impersonate":"specific",
"ImpersonatingUsers":
[
{"userLogin":"[email protected]"},
{"userLogin":"[email protected]"}
],
"shouldBackoff":true,
"backoffMinutes":"15",
"backoffRetries":"3",
"excludeSubFolders":
[
{"folder":"images"}
]
}
}
|
Code Block | ||||
---|---|---|---|---|
| ||||
# LIST
{
"type": "<Connector Type>",
"seed": "directory",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag1", "tag2"],
"properties": {
"seed": "onedrive_seed",
"usersType": "List",
"users":[
{"user": "user1"},
{"user": "user2"}
]
}
}
# FILE
{
"type": "<Connector Type>",
"seed": "directory",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag1", "tag2"],
"properties": {
"seed": "onedrive_seed",
"usersType": "List",
"seed": "onedrive_seed",
"usersType": "File",
"usersFile": "config/userNames.txt"
}
} |
Field
Required
Default
Multiple
Notes
Example
"MyOneDriveSeed"
Code Block | ||||
---|---|---|---|---|
| ||||
{
"id": "2f287669-d163-4e35-ad17-6bbfe9df3778",
"seed": "<seed example>",
"connector": "82f7f0a4-8d28-47ce-8c9d-e3ca414b0d31",
"description": "<connector>_Test_Seed",
"throttlePolicy": "6b8b5f23-fc77-47a1-9b58-106577162e7b",
"routingPolicies": ["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7", "b4d2579f-1a0a-4a8b-9fd4-d42780003b36"],
"connection": "602d3700-28dd-4a6a-8b51-e4a663fe9ee6",
"workflows": ["b255e950-1dac-46dc-8f86-1238b2fbdf27", "f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"],
"tags": ["tag", "tag2"],
"properties": {
"seed": "onedrive_seed",
"usersType": "List",
"users":[
{"user": "user1"},
{"user": "user2"}
]
}
} |