...
Select Connections > Add connection.
Select Box (Service Accounts) as the platform on the Add connection modal.
Enter the connection information. Reference the table below for details about each field.
Test the connection to ensure SkySync can connect using the information entered.
Select Done.
Add Connection Modal - Box (Service Accounts)
...
Field | Notes | Required |
|---|---|---|
Display as | Enter the display name for the connection. If you will be creating multiple connections, ensure the name readily identifies the connection. The name displays in the application, and you can use it to search for the connection and filter lists. | Required |
User Type | Required | |
Connect as a standard user | Select this option to create a standard connection to access a user's files and folders. This is the default selection. | |
Connect as an administrator | Select this option to create an administrator connection, This requires administrator privileges and grants access to all accounts within the organization. This option is often used along with impersonation to simplify transferring multiple user accounts. When connected as an administrator, the first level of folders will be user names. | |
Client ID | This value will be provided by your administrator. It can be found in your Box Developers Console or in the boxAppSettings section of {{public key}}_config.json. | Required |
Client Secret | This value will be provided by your administrator. It can be found in your Box Developers Console or in the boxAppSettings section of {{public key}}_config.json. | Required |
Enterprise ID | Enter the Enterprise ID if the connection will list content for all users on your connection root. This field is not required when an Account ID is being used. The Enterprise ID cannot be used with an Account ID; the options are mutually exclusive. | Required if not using an Account ID |
Account ID | Enter the account ID (user ID) if the connection will impersonate a single account. This field is not required when an Enterprise ID is being used. The Account ID cannot be used with an Enterprise ID; the options are mutually exclusive. | Required if not using an Enterprise ID |
Public Key ID | Enter the public key for the account. This value can be obtained from your manually generated keypair or in the boxAppSettings section of {{public key}}_config.json. | Required |
Private Key | Enter the private key for the account. This value can be obtained from your manually generated keypair or in the boxAppSettings section of {{public key}}_config.json. When you download the {{public key}}_config.json, the private key is displayed in the privatekey element. It looks something like this: "privateKey": "-----BEGIN ENCRYPTED PRIVATE KEY-----\xYZXYZxYZXyzxyzx.....................A0b0CAB0cAbCaBcabcabCA+B\noi0=\n-----END ENCRYPTED PRIVATE KEY-----\n", You only need to add the values between the quotation marks. In the above example, you would add the following as the private key: -----BEGIN ENCRYPTED PRIVATE KEY-----\xYZXYZxYZXyzxyzx.....................A0b0CAB0cAbCaBcabcabCA+B\noi0=\n-----END ENCRYPTED PRIVATE KEY-----\n | Required |
Password | Enter the password for the account. This value can be obtained from your manually generated keypair or in the boxAppSettings section of {{public key}}_config.json. The password is generated by Box when created via the download keypair from your Box Developers Console. | Required |
Behavior When Deleting Items | Select the type of delete SkySync should perform when deleting items: Permanent or Soft. Soft delete is the default delete behavior; however, Permanent is the recommended behavior. A soft delete marks items as a deleted. You can still access them to restore or permanently delete the items. A permanent delete removes the items. This delete is not reversible. | Optional |
...
| Code Block |
|---|
{
"name":"Simple Job",
"kind": "transfer",
"transfer": {
"transfer_type": "copy",
"source": {
"connection": { "id": "{{BoxServiceAccount_connection_sourceID}}" },
"impersonate_as": { "email": "user@company.com" },
"target": {
"path": "/sourceFolder"
}
},
"destination": {
"connection": { "id": "{{OneDriveForBusiness_connection_destinationID}}" },
"target": {
"path": "/Documents/destinationFolder"
}
},
"simulation_mode": false
},
"schedule": {
"mode": "manual"
},
"stop_policy": {
"on_success": 5,
"on_failure": 5,
"on_execute": 25
},
"category": {
"name": "Report {Name}"
}
} |
Related
...