Connections > Connection properties > Box Oauth connection properties
  

Box Oauth connection properties

The following table describes the Box Oauth connection properties:
Connection property
Description
Runtime Environment
The name of the runtime environment where you want to run the tasks.
Specify a Secure Agent, Hosted Agent, or serverless runtime environment.
Box API
The Box API that you want to use.
You can use one of the following API:
  • - Search_Files_or_Folders. Choose Search_Files_or_Folders to run a task that returns the list of files and folders based on search criteria. You can also select Below_is_Search API to search files or folders.
  • - Download_Files. Choose Download_Files to download files from Box to a location on the local file system.
  • - Upload_Files. Choose Upload_Files to upload files to Box from a location on the local file system.
  • - Below_are_Lists_of_Files. Choose Below_are_Lists_of_Files to read from or write to CSV files in Box.
Is Box API Dynamic
Not applicable.
URI Request Parameters
Search parameters when you use the Search_Files_or_Folders API.
For example, you can use the following string when you use the Search_Files_or_Folders API: query=generate;limit=0;offset=0
Source File Path
The directory in the machine that runs the Secure Agent to store files that you upload to Box. You must enter a value when you use the Upload_Files API.
Target File Path
The directory in the machine that runs the Secure Agent to store files that you download from Box. You must enter a value when you use the Download_Files API.
Request Type
The HTTP request type for the API. Only POST is supported in this version.
Client ID
Not applicable.
Client Secret Key
Not applicable.
Authorization Code
Not applicable.
Response Folder Path
Optional. The folder path in the machine that runs Secure Agent to store the full JSON response when you use the Search_Files_or_Folders API.
Secure Credentials File Name
Not applicable.
Create the config.csv file
Not applicable.
Authentication Required
Not applicable.
Access Token
Access token generated by Box.
You can generate an access token in the Box Developer Console.
The access token expires after two hours of generation. You must edit the connection to update the access token after 2 hours.
Box File or Folder ID
File ID or the Folder ID of the file or folder for which you want to use the connection.
You can obtain the File ID or Folder ID from the Box URL of the file or folder.
For example, the folder Reports has the following Box URL: https://company.app.box.com/files/0/f/1837615991/Reports
1837615991 is the Folder ID of Reports.
You can override this value when you create a synchronization task or a mapping task.