Configuring Box Accounts

In this article

This account is used by the Snaps in the Box Snap Pack.

You can create an account from Designer or Manager. In Designer, when working on pipelines, every Snap that needs an account prompts you to create a new account or use an existing account. The accounts can be created in or used from:

  • Your private project folder: This folder contains the pipelines that will use the account.
  • Your Project Space’s shared folder: This folder is accessible to all the users that belong to the Project Space.
  • The global shared folder: This folder is accessible to all the users within an organization in the SnapLogic instance.

Account Configuration

In Manager, you can navigate to the required folder and create an account in it (see Accounts). To create an account for Box: 

  1. Click Create, then select Box > Box.com account.
  2. Supply an account label.
  3. Click the Authorize bar. You will be asked to login into a Box account. Login with user credentials and after successful log in, you will be asked to grant permissions. You must grant permissions to make a connection.
  4. (Optional) Supply additional information on this account in the Notes field of the Info tab.
  5. Click Apply.

Avoid changing account credentials while pipelines using them are in progress. This may lead to unexpected results, including locking the account.

You need to use a Box Enterprise account.

Account Types

Box.com Account

FieldField TypeDescription
Label*StringSpecify a unique name for the account instance.
Access tokenStringThe access token for the application. The retrieval of the access token is done when setting up the account for the endpoint. There, the OAuth2 flow will be executed and the resulting access token will be stored in this property. The access token might be refreshable, in that case an optional refresh token can be stored. The user must get a new access token if the access token has expired and no refresh token was defined or both the access and the refresh token have expired.
Refresh tokenStringThe refresh token for the application. The retrieval of the refresh token is done when setting up the account for the endpoint. There, the OAuth2 flow will be executed and the resulting refresh token can be stored in this property. If the refresh token is stored, then the access token can be refreshed automatically before it expires.
Access token expirationString

The access token expiration value.

Per Box, access token must expire under 60 minutes.

OAuth2 Endpoint*String

Authorization endpoint to authorize the application.

Default Value: "https://app.box.com/api/oauth2/authorize"

Recommended value as per Box: "https://account.box.com/api/oauth2/authorize"

OAuth2 Token*String

Token endpoint to get the access token.

Default Value: "https://app.box.com/api/oauth2/token"

Recommended value as per Box: "https://api.box.com/oauth2/token"

Auth endpoint configStringProvides custom properties for the OAuth2 auth endpoint.
RefreshStringRefresh access token. Available after the account has been saved.
Auto-refresh tokenCheckboxRefreshes the token automatically using the refresh token if the property is enabled. Otherwise the token might expire and will not be automatically refreshed.
AuthorizeStarts the OAuth authorization flow. Account will be saved before authorize. 
Connection timeout (seconds)Integer

Specify connection timeout in seconds. A value of 0 indicates infinite timeout.

Default Value60
Example50

Read timeout (seconds)Integer

Specify read timeout in seconds. A value of 0 indicates infinite timeout.

Default Value900
Example600

Write Timeout (seconds)Integer

Set write timeout in seconds. A value of 0 indicates infinite timeout.

Default Value900
Example600

Box Service Account

A service account enables multiple users to use the same account for performing operations in Box. You can use this account type to connect to a Box application that has OAuth2 with JWT Token authentication. 

Prerequisite

Create a service account application in Box because all the parameters required to configure this account type are generated in the Box admin console. See JWT Application Setup for details.

See the App Settings JSON file for the account parameters. Alternatively, perform the following steps to get the parameters from the Box developer console:

  1. Log in to your Box developer console.
  2. Navigate to the Box service account app you are working with, and click Edit Application
  3. Go to the OAuth 2 Parameters section of the configuration page.
    The parameters appear against their corresponding fields.

FieldField TypeDescription
Label*String

User provided label for the account instance.

Default Value: N/A

Client ID*String

The client ID of the application requesting authentication. 

Default value: N/A
Example: plb5ltfzq9bz7micz6x6p5zfnycw98e3

Client secretString

The client secret of the application requesting authentication. 

Default Value: N/A
ExamplePCQNt3d6xym9JiiVGRqDpNcFryxKhfun

Public key IDString

The public key ID of the application. 

Default Value: N/A
Examplehs2c02ko

Private keyString

The encrypted private key.

Default Value: N/A
Example:  

-----BEGIN ENCRYPTED PRIVATE KEY-----\n

MkiG9RefG12qasOn\nMBQGCCqGSIb3DQMHBAj/xheVHRkNNgSC BMhL9TFI/pX0EVwkT44QyEOI9DuXIIlsg\nwqYR58DkP7ItCfZdFHq8 3pCwLjlvuRYsYGsb2F24OsLjCna0HsnpCbe4rvpedj7QE/aO\nN0xn8 p\nYnhxUWQzXy7ZnzYPn1wmtcaYwx+Ialn2tukqZCEpqrFf8guOjvBl aPHcMGwYJab0\n26k=\n

-----END ENCRYPTED PRIVATE KEY-----\n

Private key passphraseString

The private key passphrase associated with the encrypted private key. 

Default Value: N/A
Example176183e88324823d2318b74a1f376486

Enterprise IDString

The enterprise ID associated with the Box application. 

Default Value: N/A
Example13684983

Connection timeout (seconds)

Integer/Expression

Specify connection timeout in seconds. A value of 0 indicates infinite timeout.

Default Value60
Example50

Read timeout (seconds)

Integer/Expression

Specify read timeout in seconds. A value of 0 indicates infinite timeout.

Default Value900
Example600

Write Timeout (seconds)


Integer/Expression

Set write timeout in seconds. A value of 0 indicates infinite timeout.

Default Value900
Example600

Account Encryption

Standard Encryption

If you are using Standard Encryption, the High sensitivity settings from the table under Enhanced Encryption are followed.


Enhanced Encryption

If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account.

  • High:
  • Medium + High:
  • Low + Medium + High: Access token, Refresh token

Snap Pack History

 Click to view/expand
ReleaseSnap Pack VersionDateTypeUpdates
4.27main12833 StableAdded Connection timeout and Read timeout fields in Box accounts that enable the Box Snaps to read and write data within the specified connection and read timeouts.
4.25Patch425patches10840Latest

Modified default values for the following fields in Box Read and Box Write Snaps:

  • Number of Retries - Changed from 3 to 0.
  • Retry Interval (seconds) -  Changed from 5 to 1.

For existing Pipelines which have the Enable Staging (deprecated field) checkbox selected, this Snap retries the connection once even if the Number of Retries is zero.

4.26main11181 StableUpgraded with the latest SnapLogic Platform release.
4.25 Patch425patches10072 LatestModified default values of the following fields across the Snap Pack to trigger automatic retries by default, in case of connection failures or timeouts:
  • Number of Retries - Changed from 0 to 3
  • Retry Interval (seconds) -  Changed from 1 to 5
4.25main9554
 
Stable

Enhanced the output view of the Box Directory Browser Snap to display the error message, Error retrieving contents of the folder with id:<Folder ID> instead of No folder exists with <Folder ID> when you enter an invalid folder ID.

4.24 424patches9242 Latest
  • Enhanced the Box Snap Pack with the Retry mechanism that includes the following settings:

    • Number of Retries: Specifies the number of attempts the snap should make to perform the selected operation in case of connection failure or timeout.
    • Retry Interval (seconds)Specifies the minimum number of seconds the Snap must wait before each retry attempt.
4.24main8556 StableUpgraded with the latest SnapLogic Platform release.
4.23 Patch423patches7526 Latest

Fixes the intermittent failure in access token refresh for the Box OAuth2 account by adopting the refreshAccessTokenIfExpired() method that checks and refreshes the access token within the last minute of its expiry.

4.23main7430
 
StableUpgraded with the latest SnapLogic Platform release.
4.22 Patch422patches6992 Latest

Fixes the Box Write Snap connection retry issue by allowing the Snap to retry only when the given input is at least '1' in Number of retries field. This fix removes the Enable Staging field. 

4.22main6403
 
StableUpgraded with the latest SnapLogic Platform release.
4.21snapsmrc542

 

StableUpgraded with the latest SnapLogic Platform release.
4.20 Patch

box8743

 Latest

Fixes an issue with the Box Snap Pack wherein the OAuth2 token auto-refresh fails for Box accounts. The fix includes a patch released by Box to restore functionality to the "https://www.box.com/api/oauth2/token URL" of the deprecated version 1 of the Box API. 

Box recommends users to start using the endpoint in version 2 of the Box API: "https://api.box.com/oauth2/token" as seen in the blogpost here: https://blog.box.com/start-migrating-to-v2-of-the-content-api-deprecating-v1-in-december 

4.20snapsmrc535
 
StableUpgraded with the latest SnapLogic Platform release.
4.19 Patch azureactivedirectory8341
 
Latest

Fixes an issue with the Get Group Members Snap wherein the Snap is unable to return more than 100 users.

4.19snaprsmrc528
 
StableUpgraded with the latest SnapLogic Platform release.
4.18snapsmrc523
 
Stable
  • Added a new account type, Box Service Account, which enables you to create user accounts that can only be accessed programmatically through the APIs.
  • Added new properties, Number of retries and Retry interval (seconds), in the Box Write Snap to handle failed write attempts.
4.17ALL7402
 
Latest

Pushed automatic rebuild of the latest version of each Snap Pack to SnapLogic UAT and Elastic servers.

4.17snapsmrc515
 
Stable

Added the Snap Execution field to all Standard-mode Snaps. In some Snaps, this field replaces the existing Execute during preview check box.

4.16snapsmrc508
 
StableUpgraded with the latest SnapLogic Platform release.
4.15snapsmrc500
 
StableUpgraded with the latest SnapLogic Platform release.
4.14snapsmrc490
 
StableUpgraded with the latest SnapLogic Platform release.
4.13

snapsmrc486

 
StableUpgraded with the latest SnapLogic Platform release.
4.12 Patchbox5181 Latest
  • Fixed the Box Write Snap that fails due to a network error.
  • Fixed the Box Read Snap that hangs while processing documents. 
4.12

snapsmrc480

 
StableUpgraded with the latest SnapLogic Platform release.
4.11 Patch

box4306

 Latest

Resolved an issue with the Box Read Snap that was unable to run for longer times due to the current token getting expired. The fix helped to proceed with new access token when the current access token expires.

4.11snapsmrc465
 
StableUpgraded with the latest SnapLogic Platform release.
4.10

snapsmrc414

 
StableUpgraded with the latest SnapLogic Platform release.
4.9snapsmrc405
 
StableUpgraded with the latest SnapLogic Platform release.
4.8

snapsmrc398

 
StableUpgraded with the latest SnapLogic Platform release.
4.7

snapsmrc382

 
StableUpgraded with the latest SnapLogic Platform release.
4.6snapsmrc362
 
StableUpgraded with the latest SnapLogic Platform release.
4.5.1

box1576

 
Stable
  • Box Permissions Snap is updated to allow removing collaboration from a Box folder. For more information, see Box Permissions.
  • Box File Operations Snap is updated to route failures due to invalid source file/folder name to error view.
  • Fixed an error in Box Permissions Snap execution that caused failure in adding collaboration when the Box folder accepted a user as a collaborator.
  • Fixed an error in Box Read Snap that caused unexpected missing property values failure.
4.5rcmsf231 
  • Box Permissions Snap updated to allow for future removal of collaboration permissions.
  • Box Permissions Snap updated to disallow assigning a user as an owner.
4.3.1


Resolved an issue with Snaps in this Snap Pack not being proxy-aware.