Box
  • 01 Feb 2023
  • 3 Minutes to read
  • Dark
    Light

Box

  • Dark
    Light

Article Summary

Box is a cloud-based content management system that includes collaboration, security, analytics, and other features related to information and file storage.

⚠️ IMPORTANT

There are two session types, each of which allow you to do certain tasks.

  • User - tasks specific to an individual user
  • Enterprise - tasks for the entire company

Create a Box steps integration in Torq

  1. Go to Integrations > Steps.
  2. Locate Box and click Add.
  3. Enter a meaningful name for the integration and click Add.
  4. In your Box Developer account, enter the application you want to connect to and go to Configuration.
  5. Copy the Client ID under the OAuth 2.0 Credentials and paste that into the Client ID form in Torq.
  6. Click Fetch Client Secret and copy that into the form in Torq. In order to retrieve the Client Secret, your Box enterprise must have two-factor authentication enabled.

Screenshot of fetching the client secret from Box.Use Box steps in Torq

All Box steps require that you pass an access token as an input parameter. To generate an access token, you need to execute the step Create a session.

Create a session

Select enterprise session for steps requiring the enterprise account, and user session for steps running in an individual user's account. You will need the enterprise or user ID, both of which can be found in Box's General Settings.

Screenshot of the general settings section in Box.

After creating a session, you can proceed with any of the Box steps Torq has included, or create an HTTP step of your own.

Get users in enterprise

All you need for this step is to run the Create Session step with your enterprise ID, and use the Access Token generated. A list of all users will be returned to you.

Search content

  1. Use the Access Token created in {{ $.create_session.api_object.access_token }}
  2. Search for the information you would like to find, using quotation marks for exact matches (e.g: “John Doe” and not “john doe”)
    1. You may search for multiple items at once by using the AND, OR, and NOT operators. For example: John Doe AND “Mississippi” OR torq will get you all the files that include mentions of both John Doe (or john doe) and “Mississippi”, or that include Torq or torq.
    2. You can also limit more of the search including limit of items, types of files, and more by opening the Manage Parameters icon.

Screenshot of configuring the search content step for Box.

Create folder

  1. Use the Access Token created in {{ $.create_session.api_object.access_token }}
  2. Configure the required step parameter.
    1. CREATE_FOLDER_NAME: Give the folder a unique and relevant name.
    2. CREATE_FOLDER_PARENT_ID: From your Search Content step, access the API object entries and the parent ID of the folder you would like to be the parent folder for your new item.

Set folder permissions

  1. Use the Access Token created in {{ $.create_session.api_object.access_token }}.
  2. Change the folder permissions to either "open" to allow the folder to be public, or "company" to restrict the folder to only enterprise members, or "collaborators" to allow for the folder to be shared.
  3. Change the download permissions to either "true" or "false" according to if you want the folder to be able to download links.
  4. For Folder ID, use the ID created in the create folder step {{ $.create_folder_1.api_object.id }}.

box-set-folder-permissions-step

Get folder information

  1. Use the Access Token created in {{ $.create_session.api_object_access_token }}
  2. For Folder ID, use the ID created in {{ $.create_folder_1.api_object.id }} or {{ $.search_content.api_object.entries.0.parent.id }}

Update file

  1. Use the Access Token created in {{ $.create_session.api_object_access_token }}
  2. Access the file ID by visiting the file in the Box web application and copying the ID from the end of the URL.
  3. Paste the ID into the proper field.
  4. Change the desired file information by opening the parameter's icon. From there you can update the description and name.

Premade steps

  • Create a folder
  • Create a session
  • Delete a file
  • Delete a folder
  • Get file information
  • Get folder information
  • Get users in the enterprise
  • List items in a folder
  • Lock a file
  • Search content
  • Set file permissions
  • Set folder permissions
  • Unlock a file
  • Update a file
  • Update a folder

Was this article helpful?

What's Next
Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.