Box

1. Select Authentication from the navigation menu or the dashboard.

2. Click the New Authentication button

3. Enter a unique name for the connection and give it a description

4. Select the connection type from the drop-down and click save.

5. Fill in the configuration settings on the edit connection page and click save.

• If using Java 8, JWT Authentication requires the installation of the Java Cryptography Extension.

• Ensure your account has 2-step verification enabled.

• Navigate to the Developers Console (link)

• Choose Create New App

• Select Custom App

  

• Select Server Authentication (with JWT).

  Note:  Box removed the ability to change this selection early in 2021, so this choice is permanent.

  

  Tip:  In your applications you should see Service Account Info. The Service Account ID is the service user's email address and must be a collaborator on any folder you wish to migration

• Under the Configuration tab in App Access Level, select the enterprise setting

  

• In Application Scopes make sure both Content Actions are checked

• In Advanced Features, check both options

  

• Click on Generate a Public/Private Keypair

• Open the file provided. It should take the following form

  Copy

  {
    "boxAppSettings": {
      "clientID": "",
      "clientSecret": "",
      "appAuth": {
        "publicKeyID": "",
        "privateKey": "",
        "passphrase": ""
      }
    },
    "enterpriseID": ""
  }

  Take the entire value of the private key and save it to a separate file. This will be your private key file.

  The information in this config file can be used to fill in the fields of aBox Integration Connection.

  Alternatively, you can use the file to create a JWT Authentication Connector.

  • To authorise your app follow Box's instructions. Pay particular attention to the App Approval section.

  Logging in as the Service User

• Navigate to your account's admin console ( yourapp.app.box.com/master )

• Click Content

• Select User(s) to view their content

• If you right-click, you can select "Log in to users account"

• This gives you the standard Box application view, allowing you to gather Folder Ids, etc. while in the view of the user.

Important:  SSL REQUIRED
This requires tomcat to be running using the 'https' protocol. Box will not accept 'http://' addresses. Tomcat will need to be configured to use SSL/TLS.

Creating a Box OAuth Application requires you to choose the Standard OAuth 2.0 Authentication Method in the Create a New App screen.

• In The Configuration tab of your app, retrieve the clientId and clientSecret.

• In App Access Level, select the enterprise setting

  

• In Application Scopes make sure both Content Actions are checked

• In Advanced Features, check both options

  

  https://[simflofyUrl]/3sixty-admin/authconn/oauthcb

Box JWT Authentication Connection Configuration Example

• Name: cs-Box JWT Auth Connector

• Type: Box JWT Auth Connector

• app_user_base: Simflofy App User

• box_app_users: 5

• box_as_user: Not Set

• box_connect_timeout: 10000

• box_key_file: Not Set

• box_key_json: { "boxAppSettings": { "clientID": "ovpnkjj4......}

• box_read_timeout: 60000

• enableSDKLogging: false

• proxyhost: Not Set

• proxypassword: ***

• proxyport: 80

• proxyusername: Not Set

• sdkLoggingLevel: INFO

1. Select Content Service under Connections in the navigation menu

2. Click the New Connection button

3. Fill in the following configuration fields.

The API supports GET, POST, and DELETE calls. All the endpoints take the "id" parameter, which takes the form of a number. Ex.77411856592.

A guide to available box roles can be found here:

Read Permissions (ACLs)

Request:

GET /repo/(connectorId)/acls?id=(id)&isFolder=(isFolder)

Description:

Retrieves a list of in the format of ["UserName(UserId):Role",..... ]

You will need to extract the UserId or Name from each item for use in POST/DELETE request.

Path Parameters:

connectorId: The connector ID of your content service connector

Query Parameters:

id: The repository id of the item.

Optional Parameters:

isFolder: Is the item a folder? Default is false.

GET repo/box/acls?id=77411856592&isFolder=true

Returns:

{

"results": [ "M Lugert(77567866603):EDITOR", "JLipton(77422856603):VIEWER" ],

"success": true

}

Example With CURL

curl -u admin:admin "localhost:8081/3sixty-admin/api/repo/**box/acls?id=77411856592 &isFolder=true**" | json_pp

Write Permssions (ACLs)

Request:

POST /repo/(connectorid)/acls?id=(id)&acls=(acls)&isFolder=(isFolder)&viewPath=(viewPath)&notify=(notify)&isGroup=(isGroup)

Description:

Adds acls to the selected document.

It is important to note that Box collaborations are inherited from the parents. The parent of the item must also have the collaboration being added or a 403 response will occur.

Path Parameters:

connectorid: The connector id of your content service connector

Query Parameters:

id: The repository id of the item.

acls: A JSON Object in the format {"User1":"Permission1","User2":"Permission2"}

Optional Parameters: Applied for each pair in acls

isFolder: Is the item a folder? Default is false.

viewPath: Dictates whether the collaborator can view the parent path of the item. Default true.

notify: If true, will send a notification for each collaboration created. Default false.

isGroup: If true, will attempt use the supplied id to add collaboration for a group. Default false

This will not work with an email address as groups don't have them.

Example from Postman

POST repo/box/acls?id=77411856592&acls={"testuser@box.com":"EDITOR"}&notify=true&isFolder=true

Returns:

Copy

{
  "results": [
    "M Lugert(77567866603):EDITOR",
    "J Lipton(77422856603):VIEWER",
    "testuser@box.com(77427777603):EDITOR"
  ],
  "success": true
}

Example With CURL

curl -u admin:admin -X POST "localhost:8081/3sixty-admin/api/repo/**box/acls?id=77411856592&acls={"testuser@box.com":"EDITOR"}&notify=true&isFolder=true**" | json_pp

Delete Permissions (ACLs)

Request:

DELETE /repo/(connectorid)/acls?id=(id)&aclId=(aclId)&isFolder=(isFolder)

Description:

Removes the permissions for the supplied User or Group IDs from and item.

Path Parameters:

connectorid: The connector id of your content service connector

Query Parameters:

id: The repository id of the item.

aclId: A comma delimited list of User or Group Ids to remove from the item

Optional Parameters:

isFolder: Is the item a folder? Default is false.

DELETE repo/box/acls?id=77411856592&isFolder=true&aclId=testuser@box.com,77422856603

Returns:

Copy

{
  "success": true
}

The following GET call should produce:

Copy

{
  "results": [
    "M Lugert(77567866603):EDITOR"
  ],
  "success": true
}

Example With CURL

Copy

curl -u admin:admin "localhost:8081/3sixty-admin/repo/box/acls?id=77411856592&isFolder=true&aclId=testuser@box.com,77422856603" | json_pp

• createFile

• createFolder

• createVersion

• deleteACL

• deleteFolder

• deleteObjectByID

• deleteVersion

• getACLs

• getFileContent

• getObjectProperties

• getTypes

• getVersionContent

• listFolderItems

• listVersions

• lockDocument

• revertVersion

• setACLs

• unlockDocument

• updateFile

• updateProperties

1. Select List Jobs under integration on the navigation menu or the dashboard

2. Click the create job button

3. In the New Job form

   1. Name the job

   2. Select Simple Migration from the job type drop down

   3. Select the Repository Connection

   4. Select the Output connection

   5. Select your Content Service Connection

      (Only required if you will be using Federation)

   6. Click Save to open the Edit Job page

   7. Fill in the configurations for the Repo and Output Configuration tabs

4. Click save to save your new integration job

1. Select Run and Monitor Jobs under Integration in the navigation menu

2. Click the play button next to the job you want to run

3. Click the refresh button to view your completed job status

   (Larger jobs will take longer to run)

1. Click on the task tab in your integration job.

2. Find the task you want to create in the drop down. Tasks are grouped by type. You can also search for the task by name.

3. Select the create task button

4. Fill out the configuration fields. Some tasks do not require configuration.

5. Click Done to save the task to your job.

Metadata Templates in Box

Box uses metadata templates to contain data outside of the global scope.

In order to add or view current content templates, first go to the Admin Console

Then click on Content

Once in the Content Manager page, click on Metadata.

You should now see a page with all available metadata templates. If there are none, then there are current no templates.

So, lets make one! Click on Create New, and you'll see the following:

You'll see a number of fields here. First, we need to name the template (Name Your Template is a form field).

Then, we'll need to select a metadata type. This will be important for mappings later. Currently, 3Sixty supports the three basic types (Number, Date Text).

Here's an image of the form filled out for a text field.