Create Credential

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	Box App Client Id
ClientSecret	Yes	-	No	Box App Client Secret
useJWT	Yes	false	No	Indicates if we want to use JWT individual credentials
jwtconfigdir	Yes	-	No	Path of the JWT generated config file
publicKeyID	Yes	-		PublicKey ID from JWT
privateKey	Yes	-		PrivateKey
passphrase	Yes	-		Passphrase for the private key
enterpriseID	Yes	-		EnterpriseID of your Box Account

Example

PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

{
    "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "description": "<Connector Name> Credential",
    "properties": {   
		"credentialType": "basic"
        "ClientId": "6znlpe3l2xoknk1x1l35j029z4i5erty",
        "ClientSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
	}
}

JWT
{
    "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "description": "<Connector Name> Credential",
    "properties": {   
		"credentialType": "jwt"
        "useJWT": "false",
        "jwtconfigdir": "c:\dev\configJWT.json"
	}
}

Update Credential

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the credential to update.	"2f287669-d163-4e35-ad17-6bbfe9df3778"
description	Yes	-	No	Name of the credential object.	"OneDriveCredential"
properties	Yes	-	No	Configuration object
domain	Yes	-	No	Tenant domain	yourdomain.onmicrosoft.com
appID	Yes	-	No	Azure application ID registered	sampleapplicationid
appSecret	Yes	-	No	Azure application secret	xxxxxxxxxxxxxxxxxxxxxxxxxx
graphURL	Yes	-	No	The graph URL	https://graph.microsoft.com/v1.0

Example

PUT aspire/_api/credentials/2a5ca234-e328-4d40-bb2a-2df3e550b065

{
    "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "description": "<Connector Name> Credential",
    "properties": {   
		"credentialType": "basic"
        "ClientId": "6znlpe3l2xoknk1x1l35j029z4i5erty",
        "ClientSecret": "xxxxxxxxxxxxxxxxxxxxxxxxxx"
	}
}

JWT
{
    "id": "2a5ca234-e328-4d40-bb2a-2df3e550b065",
    "description": "<Connector Name> Credential",
    "properties": {   
		"credentialType": "jwt"
        "useJWT": "false",
        "jwtconfigdir": "c:\dev\configJWT.json"
	}
}

Create Connection

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.	"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[^/]$"}]

Example

POST aspire/_api/connections

{     
	"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": {
        "indexContainers": true,
        "scanRecursively": true,
        "scanExcludedItems": false,
        "includes": [
            {"include": ".*tmp[^/]$"}
        ],
        "excludes": [
            {"exclude": ".*tmp[^/]$"}
        ]
    } 
}

Update Connection

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the connection to update	"89d6632a-a296-426c-adb0-d442adcab4b0",
description	No	-	No	Name of the connection object.	"MyConnection"
credential	Yes	-	No	ID of the credential that applies to this connection object.	"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	TRUE	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[^/]$"}]
include	No	-	No	regex URL patterns to include	".*tmp[^/]$"
excludes	No	-	Yes	List of regex URL patterns to exclude	[{"include":".*tmp[^/]$"}]
exclude	No	-	No	regex URL patterns to exclude	".*tmp[^/]$"

Example

{     
	"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": {        
        "indexContainers": true,
        "scanRecursively": true,
        "scanExcludedItems": false,
        "includes": [
            {"include": ".*tmp[^/]$"}
        ],
        "excludes": [
            {"exclude": ".*tmp[^/]$"}
        ]    
    } 
}

Create Connector Instance

For the creation of the Connector object using the Rest API, please refer to this page.

Update Connector Instance

For the update of the Connector object using the Rest API, please refer to this page.

Create Seed

Field	Required	Default	Multiple	Notes	Example
seed	Yes	-	No	<seed description>
type	Yes	-	No	The value must be one-drive.	onedrive
description	Yes	-	No	Name of the seed object.	"My OneDrive 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 onedrive_seed	"onedrive_seed"
usersType	Yes	"List"	No	The way to add the users to crawl ("List" or "File")	"List"
users	No	-	Yes	Only required if usersType "List" is selected. List of users	[{"user": "user1"},{"user": "user2"}]
user	No	-	No	Only required if usersType "List" is selected. User Principal Name	"[email protected]"
usersFile	No	-	No	Only required if usersType "File" is selected. The path to the names list file	"config/userNames.txt"

Example

POST aspire/_api/seeds

# 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"     
	}
}

Update Seed

Field	Required	Default	Multiple	Notes	Example
id	Yes	-	No	ID of the seed to update.	"2f287669-d163-4e35-ad17-6bbfe9df3778"
seed	No	-	No	<seed description>
description	No	-	No	Name of the seed object.	"MyOneDriveSeed"
connector	No	-	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	No	-	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"]
workflows.add	No	[ ]	Yes	The IDs of the workflows to add.	["f8c414cb-1f5d-42ef-9cc9-5696c3f0bda4"]
workflows.remove	No	[ ]	Yes	The IDs of the workflows to remove.	["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"]
routingPolicies.add	No	[ ]	Yes	The IDs of the routingPolicies to add.	["b4d2579f-1a0a-4a8b-9fd4-d42780003b36"]
routingPolicies.remove	No	[ ]	Yes	The IDs of the routingPolicies to remove.	["313de87c-3cb9-4fe0-a2cb-17f75ce7d0c7"]
tags	No	[ ]	Yes	The tags of the seed. These can be used to filter the seed.	["tag1", "tag3"]
tags.add	No	[ ]	Yes	The tags to add	["tag4"]
tags.remove	No	[ ]	Yes	The tags to remove	["tag2"]
properties	Yes	-	No	Configuration object
seed	Yes	-	No	This value must be onedrive_seed	"onedrive_seed"
usersType	Yes	"List"	No	The way to add the users to crawl ("List" or "File")	"List"
users	No	-	Yes	Only required if usersType "List" is selected. List of users	[{"user": "user1"},{"user": "user2"}]
user	No	-	No	Only required if usersType "List" is selected. User Principal Name	"[email protected]"
usersFile	No	-	No	Only required if usersType "File" is selected. The path to the names list file	"config/userNames.txt"

Example

PUT aspire/_api/seeds/2f287669-d163-4e35-ad17-6bbfe9df3778

{
    "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"}
		 ]
	}
}

Page tree

Create Credential

Example

Update Credential

Example

Create Connection

Example

Update Connection

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Update Seed

Example

Contact Us: [email protected]

Page tree

REST API - Box.com Connector - Configuration

Create Credential

Example

Update Credential

Example

Create Connection

Example

Update Connection

Example

Create Connector Instance

Update Connector Instance

Create Seed

Example

Update Seed

Example

Contact Us: [email protected]