Establishing a Connection

Adding a Connection to Box

To add a connection to Box:

In the application console, navigate to the Connections page.
At the Add Connections panel, select the icon for the connection you want to add.
If the Box icon is not available, click the Add More icon to download and install the Box connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Box

The Sync App enables access to metadata for Box tables and folders. Note that the Sync App cannot update the contents of files stored on Box or model file content as tables and columns.

Authenticating to Box

The Sync App uses the OAuth authentication standard to connect to Box from either a User account or a Service account.

Box provides embedded OAuth credentials that simplify connection from a Desktop application . To connect from a Web application, you must create a custom OAuth application, as described in Creating a Custom OAuth Application.

The following subsections describe how to authenticate to Box from the available OAuth flows. For information about how to create a custom OAuth application, and why you might want to create one even for auth flows that already have embedded OAuth credentials, see Creating a Custom OAuth Application.

For a complete list of connection string properties available in Box, see Connection.

User Accounts (OAuth)

AuthScheme must be set to OAuth in all user account flows.

Service Account (OAuthJWT)

Service accounts have silent authentication, which does not require user authentication in the browser. You can also use a service account to delegate enterprise-wide access scopes to the Sync App.

To use a service account, you must create and authorize a custom OAuth application, as described in Creating a Custom OAuth Application. You can then connect to whatever Box data the service account is permitted to access.

After setting the following connection properties, you are ready to connect:

AuthScheme: OAuthJWT.
OAuthClientId: The client Id noted in your custom OAuth application settings.
OAuthClientSecret: The client secret noted in your custom OAuth application settings.
OAuthJWTCertType: PEMKEY_FILE.
OAuthJWTCert: The path to the .pem file you generated.
OAuthJWTCertPassword: The password of the .pem file.
OAuthJWTCertSubject: The subject of the certificate. If you want to select the first certificate in the Certificate Store, set an * (asterisk).
OAuthJWTSubjectType: The same as what you specified in your Application Access Values; either "enterprise" or "user". The default value of this connection property is "enterprise".
OAuthJWTSubject: If your subject type is set to enterprise, this should be your enterprise Id. If your subject type is set to user, this should be your application user Id.
OAuthJWTPublicKeyId: The Id of your public key in your application settings.

When you connect the Sync App completes the OAuth flow for a service account.

BOXJSON OAuthJWTCertType

To authenticate using a service account and the BOXJSON OauthJWTCertType, set these properties:

AuthScheme: OAuthJWT.
OAuthJWTCertType BOXJSON. OAuthJWTCert: The path to the Box-provided JSON file.

In cases where it may not be feasible to use a file in your system. you can copy the contents of the JSON file directly into the connection string. Set these properties:

AuthScheme: OAuthJWT.
OAuthJWTCertType: BOXJSONBLOB.
OAuthJWTCert: The contents of the Box-provided JSON file.

Advanced Features

This section details a selection of advanced features of the Box Sync App.

User Defined Views

The Sync App supports the use of user defined views, virtual tables whose contents are decided by a pre-configured user defined query. These views are useful when you cannot directly control queries being issued to the drivers. For an overview of creating and configuring custom views, see User Defined Views .

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats;. For further information, see the SSLServerCert property under "Connection String Options" .

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Box and then processes the rest of the query in memory (client-side).

For further information, see Query Processing.

Logging

For an overview of configuration settings that can be used to refine CData logging, see Logging. Only two connection properties are required for basic logging, but there are numerous features that support more refined logging, which enables you to use the LogModules connection property to specify subsets of information to be logged.

SSL Configuration

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.

To specify another certificate, see the SSLServerCert connection property.

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

To authenticate to an HTTP proxy, set the following:

ProxyServer: the hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort: the TCP port that the proxy server is running on.
ProxyAuthScheme: the authentication method the Sync App uses when authenticating to the proxy server.
ProxyUser: the username of a user account registered with the proxy server.
ProxyPassword: the password associated with the ProxyUser.

Other Proxies

Set the following properties:

To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
To tunnel the connection, set FirewallType to TUNNEL.
To authenticate, specify FirewallUser and FirewallPassword.
To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

Data Model

The Sync App enables access to metadata for Box tables and folders, as well as related entities such as Users, Tasks, and Groups.

Tables

The Sync App models Box entities, such as Files, Folders, and Users as relational Tables.

Views

Views are read-only tables that model Box entities such as FileVersions and UserEvents.

Stored Procedures

Stored Procedures are function-like interfaces to Box. They can be used to perform tasks such as downloading, uploading, and copying files.

Dynamic Collection Views

You can use ExposeCollectionViews to expose your Box collections as separate views and query the metadata information of their files and folders. The name of the generated views are prefixed with "Collection_". Additionally, AsUserId can be used to expose the collections of only a certain user and IncludeCustomFields can be used to expose custom metadata fields as columns on these views.

Tables

The Sync App models the data in Box as a list of tables in a relational database that can be queried using standard SQL statements.

Box Connector for CData Sync Tables


Name	Description
Bookmarks	Query, insert, update and delete the available bookmarks in Box.
Collaborations	Create, update, delete, and query the available Collaborations in Box.
Comments	Create, update, delete, and query the available Comments in Box.
Folders	Create, update, delete, and query the available Folders in Box.
Groups	Create, update, delete, and query the available Groups in Box.
LegalPolicies	Query all legal hold policies that belong to an enterprise.
Memberships	Create, update, delete, and query the available Memberships in Box.
MetadataTemplates	Create, update, delete and query the Metadata Templates in Box
TaskAssignments	Create, update, delete, and query the available Task Assignments in Box.
Tasks	Create, update, delete, and query the available Tasks in Box.
TrashedItems	Delete and query the available TrashedItems in Box.
Users	Create, update, delete, and query the available Users in Box.

Bookmarks

Query, insert, update and delete the available bookmarks in Box.

Table Specific Information

Select

If you search for bookmarks without specifying any condition in the WHERE Clause, by default only the bookmarks that are at most 5 levels deep from the root folder will be returned. You can change the default depth value in the connection string; e.g. DirectoryRetrievalDepth=10.

SELECT * FROM Bookmarks

By default, the search starts from the root directory, identified as directory '0'. To customize the starting directory for your search, specify its ID using the SearchRootId column.

SELECT * FROM Bookmarks WHERE SearchRootId = '293533136411'

Retrieve a bookmark by specifying the Id:

SELECT * FROM Bookmarks WHERE Id = '8397822180'

To search all the bookmarks in your enterprise, query the bookmarks table with the column SearchTerms.

SELECT * FROM Bookmarks WHERE SearchTerms LIKE '%CData%' AND OwnerUserIds = '311997108,1'

To search all the bookmarks within a specific folder, query the bookmarks table with the ParentId column.

SELECT * FROM Bookmarks WHERE ParentId = 62297447480

Note: When using a ParentId filter, avoid specifying a SearchRootId simultaneously. If both are used, the search will recursively start from the specified SearchRootId instead of the ParentId, which may result in slower performance.

If you're authenticated as an administrator with user impersonation permissions, you can query bookmarks from multiple user accounts:

SELECT * FROM Bookmarks WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query bookmarks associated with their account.
Bookmarks shared with multiple users are only returned for one of the users.

Insert

To insert a bookmark you must specify at least the URL and ParentId column.

INSERT INTO Bookmarks (Url, Name, Description, ParentId) VALUES ('https://www.cdata.com/', 'CData', 'Visit CData!', 0)

Update

Any column where ReadOnly=False can be updated.

UPDATE Bookmarks SET Name = 'CData Updated Bookmark', ParentId = 62297447480  WHERE Id = 8397822180

Delete

Bookmarks can be deleted by providing an Id and issuing a DELETE statement. This bookmark is then moved to TrashedItems.

DELETE FROM Bookmarks WHERE Id = 8397822180

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the bookmark.
Url	String	False	The URL of the bookmark.
Name	String	False	The name of the bookmark.
Description	String	False	The description of the bookmark.
ParentId	String	False	The Id of the folder that contains the bookmark.
CreatedAt	Datetime	True	The date the content of the bookmark was created at.
CreatedById	String	True	The Id of the user that created the bookmark.
CreatedByName	String	True	The Name of the user that created the bookmark.
CreatedByLogin	String	True	The Login of the user that created the bookmark.
ModifiedAt	Datetime	True	The date the content of the bookmark was modified at.
ModifiedById	String	True	The Id of the user that last modified the bookmark.
ModifiedByName	String	True	The Name of the user that last modified the bookmark.
ModifiedByLogin	String	True	The Login of the user that last modified the bookmark.
OwnedById	String	True	The Id of the user that owns the bookmark.
OwnedByName	String	True	The Name of the user that owns the bookmark.
OwnedByLogin	String	True	The Login of the user that owns the bookmark.
Etag	String	True	The Etag of the bookmark
SequenceId	String	True	The sequence Id of the bookmark.
SharedLink	String	True	The shared url of the bookmark.
ItemStatus	String	True	The status of the bookmark.
Path	String	True	The full path of the bookmark.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.
SearchRootId	String	True	The folder Id to start the recursive search through the folder tree. Default is '0' as root folder.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SearchTerms	String	Query to search the bookmarks database.
Scope	String	The scope of the search. The allowed values are user_content, enterprise_content.
OwnerUserIDs	String	The Ids of the owners to limit the search to, separated by a comma.
AncestorFolderIDs	String	The Ids of the folders to limit the search to, separated by a comma.

Collaborations

Create, update, delete, and query the available Collaborations in Box.

Table Specific Information

Collaborations are connections between Folders and Groups; i.e., one Group could be collaborating on a specific Collaboration.

Select

To query the Collaborations table, specify an Id, FolderId, or a GroupId.

SELECT * FROM Collaborations WHERE Id = '123'

If you're authenticated as an administrator with user impersonation permissions, you can query collaborations from multiple user accounts:

SELECT * FROM Collaborations WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query collaborations associated with their account.
Collaborations shared with multiple users are only returned for one of the users.

Insert

To insert into Collaborations you need to connect a Folder with a Group or a User and assign a Role to them.

INSERT INTO Collaborations (Role, ItemId, ItemType, AccessibleById, AccessibleByType) VALUES ('admin', '1', 'folder', '2', 'user')

Update

Only the Role and the Status of the Collaboration can be updated.

UPDATE Collaborations SET Role = 'viewer', Status = 'accepted' WHERE Id = '100'

Delete

Collaborations can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Collaborations WHERE Id = '100'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the collaboration.
CreatedAt	Datetime	True	The date the collaboration was created at.
ModifiedAt	Datetime	True	The date the collaboration was modified at.
AcknowledgedAt	Datetime	True	The date the collaboration was acknowledged.
CreatedById	String	True	The Id of the user that created the collaboration.
Status	String	False	The status of the collaboration.
Role	String	False	The role of the user or group of the collaborator. Allowed values are editor, viewer, previewer, uploader, previewer uploader, viewer uploader, co-owner, or owner
ItemId	String	False	The Id of the item the collaboration is related to.
ItemType	String	False	The type of the item the collaboration is related to.
AccessibleById	String	False	The Id of the group/user that can access this collaboration.
AccessibleByType	String	False	The type of the entity of Accessible_By_Id. The allowed values are group, user.
AccessibleByLogin	String	False	The login of the the Accessible_By_Id.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
FolderId	String	The Id of the folder the collaboration is related to.
GroupId	String	The Id of the group the collaboration is related to.

Comments

Create, update, delete, and query the available Comments in Box.

Table Specific Information

Comments are additional information passed on to a File. These Comments can also have child Comments.

Select

To query the Comments table specify an Id or a FileId.

SELECT * FROM Comments WHERE Id = '123'

If you're authenticated as an administrator with user impersonation permissions, you can query comments from multiple user accounts:

SELECT * FROM Comments WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query comments associated with their account.
Comments shared with multiple users are only returned for one of the users.

Insert

To insert into Comments you need to specify the item to insert the Comment into and the Message. You need to either specify a Message or a TaggedMessage but not both.

INSERT INTO Comments (ItemId, ItemType, Message) VALUES ('1', 'file', 'example comment')

Update

Only the message of the Comment can be updated.

UPDATE Comments SET Message = 'editor' WHERE Id = '100'

Delete

Comments can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Comments WHERE Id = '100'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the comment.
Message	String	False	The plain message of the comment. Use only this or tagged_message not both.
TaggedMessage	String	False	The tagged message of the comment. Setting this as @[USER_ID:USERNAME] tags the user and notifies him. A tagged message that does not contain a proper tag will give an error.
ItemId	String	False	The Id of the item the comment is targeted to.
ItemType	String	False	The type of the item the comment is targeted to. This can be a file or another comment. The allowed values are file, comment.
CreatedById	String	True	The id of the user that created the item.
CreatedByName	String	True	The name of the user that created the item.
CreatedByLogin	String	True	The login user that created the item.
CreatedAt	Datetime	True	The date the item was created.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
FileID	String	The File ID the comment is connected to, is not used to insert to this table.

Files

Update, delete, and query the available Files in Box.

Table Specific Information

Select

If you search for files without specifying any condition in the WHERE Clause, by default only the files that are at most 5 levels deep from the root folder will be returned. You can change the default depth value in the connection string; e.g. DirectoryRetrievalDepth=10.

SELECT * FROM Files

By default, the search starts from the root directory, identified as directory '0'. To customize the starting directory for your search, specify its ID using the SearchRootId column.

SELECT * FROM Files WHERE SearchRootId = '293533136411'

To search all the Files in your enterprise, query the Files table with the column SearchTerms.

SELECT * FROM Files WHERE SearchTerms LIKE '%untitled%'

To search all the Files within a specific folder, query the Files table with a filter on the relevant folder's Id in the ParentId column.

SELECT * FROM Files WHERE ParentId = '12'

Note: When using a ParentId filter, avoid specifying a SearchRootId simultaneously. If both are used, the search will recursively start from the specified SearchRootId instead of the ParentId, which may result in slower performance.

Update

Any column where ReadOnly=False can be updated.

UPDATE Files SET Description = 'example description', Sharedlink = 'http://sharedlink.com', OwnedbyId = '321', ParentId = '12', Name = 'updated file name' WHERE Id = '123'

Delete

Files can be deleted by providing an Id and issuing a DELETE statement. This file is then moved to TrashedItems

DELETE FROM Files WHERE Id = '100'

Columns


Name	Type	ReadOnly	Description
SearchTerms	String	True	Query to search the files database.
Id [KEY]	String	True	The Id of the file.
Name	String	False	The name of the file.
Sha1	String	False	The SHA-1 encryption of the file.
Etag	String	False	The Etag of the file
SequenceId	String	False	The sequence Id of the file.
Description	String	False	The description of the file.
Size	Integer	True	The size of the file.
CreatedAt	Datetime	True	The date the file was created at.
ModifiedAt	Datetime	True	The date the file was modified at.
TrashedAt	Datetime	True	The date the file was trashed at.
PurgedAt	Datetime	True	The date the file was purged at.
ContentCreatedAt	Datetime	True	The date the content of the file was created at.
ContentModifiedAt	Datetime	True	The date the content of the file was modified at.
CreatedById	String	True	The Id of the user that created the file.
CreatedByName	String	True	The Name of the user that created the file.
CreatedByLogin	String	True	The Login of the user that created the file.
SharedLink	String	False	The shared url of the file.
ModifiedById	String	True	The Id of the user that last modified the file.
ModifiedByName	String	True	The Name of the user that last modified the file.
ModifiedByLogin	String	True	The Login of the user that last modified the file.
OwnedById	String	False	The Id of the user that owns the file.
OwnedByName	String	False	The Name of the user that owns the file.
OwnedByLogin	String	False	The Login of the user that owns the file.
ParentId	String	False	The Id of the folder that contains the file.
ItemStatus	String	False	The status of the file.
Path	String	True	The full path of the file.
SearchRootId	String	True	The folder Id to start the recursive search through the folder tree. Default is '0' as root folder.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Scope	String	The scope of the search.
FileExtension	String	The extension of the file.
ContentTypes	String	The content to search the query at, separated by commas. This can contain a mixture of the following: name, file_content, description, comments, tags.
OwnerUserIDs	String	The Ids of the owners to limit the search to, separated by a comma.
AncestorfolderIDs	String	The Ids of the folders to limit the search to, separated by a comma.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Folders

Create, update, delete, and query the available Folders in Box.

Table Specific Information

Select

If you search for folders without specifying any condition in the WHERE Clause, by default only the folders that are at most 5 levels deep from the root folder will be returned. You can change the default depth value in the connection string; e.g. DirectoryRetrievalDepth=10.

SELECT * FROM Folders

By default, the search starts from the root directory, identified as directory '0'. To customize the starting directory for your search, specify its ID using the SearchRootId column.

SELECT * FROM Folders WHERE SearchRootId = '293533136411'

To search all the Folders in your enterprise, query the Folders table with the column SearchTerms.

SELECT * FROM Folders WHERE SearchTerms LIKE '%untitled%'

To search all the Folders within a specific folder, query the Folders table with the ParentId column.

SELECT * FROM Folders WHERE ParentId = '12'

Note: When using a ParentId filter, avoid specifying a SearchRootId simultaneously. If both are used, the search will recursively start from the specified SearchRootId instead of the ParentId, which may result in slower performance.

If you're authenticated as an administrator with user impersonation permissions, you can query folders from multiple user accounts:

SELECT * FROM Folders WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query folders associated with their account.
Folders shared with multiple users are only returned for one of the users.

Insert

You're required to specify the name of the Folder and also the Id of the parent Folder. Use 0 for the root Folder's ParentId.

INSERT INTO Folders (Name, ParentId, SharedLink, Description, Access, OwnedById) VALUES ('new folder', '0', 'http://sharedlink.com', 'example desc', 'open', '123')

Update

Any column where ReadOnly=False can be updated.

UPDATE Folders SET Description = 'example description', Access = 'open', SharedLink = 'http://sharedlink.com', OwnedById = '321', ParentId = '12', Name = 'no longer new folder'  WHERE Id = '123'

Delete

Folders can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Folders WHERE Id = '123'

Columns


Name	Type	ReadOnly	Description
SearchTerms	String	True	Query to search the folders database.
Id [KEY]	String	True	The Id of the folder.
Name	String	False	The name of the folder.
Etag	String	True	The Etag of the folder
SequenceId	String	False	The sequence Id of the folder.
Description	String	False	The description of the folder.
Access	String	False	The email access of this folder to. The allowed values are open, collaborators.
Size	Integer	True	The size of the file.
CreatedAt	Datetime	True	The date the file was created at.
ModifiedAt	Datetime	True	The date the file was modified at.
TrashedAt	Datetime	True	The date the folder was trashed at.
PurgedAt	Datetime	True	The date the folder was purged at.
ContentCreatedAt	Datetime	True	The date the content of the folder was created at.
ContentModifiedAt	Datetime	True	The date the content of the folder was modified at.
CreatedBy	String	True	The Id of the user that created the folder.
CreatedByName	String	True	The Name of the user that created the folder.
CreatedByLogin	String	True	The Login of the user that created the folder.
SharedLink	String	False	The Id of the user that created the folder.
ModifiedBy	String	True	The Id of the user that last modified the folder.
ModifiedByName	String	True	The Name of the user that last modified the folder.
ModifiedByLogin	String	True	The Login of the user that last modified the folder.
OwnedById	String	False	The Id user that owns the folder.
OwnedByName	String	True	The Name of the user that owns the folder.
OwnedByLogin	String	True	The Login of the user that owns the folder.
ParentId	String	False	The Id of the folder that contains the folder.
ItemStatus	String	True	The status of the folder.
Path	String	True	The full path of the folder.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.
SearchRootId	String	True	The folder Id to start the recursive search through the folder tree. Default is '0' as root folder.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Scope	String	The scope of the search.
ContentTypes	String	The content to search the query at, separated by commas. This can contain a mixture of the following: name, file_content, description, comments, tags.
OwnerUserIDs	String	The Ids of the owners to limit the search to, separated by a comma.
AncestorfolderIDs	String	The Ids of the folders to limit the search to, separated by a comma.

Groups

Create, update, delete, and query the available Groups in Box.

Table Specific Information

Select

You can retrieve all the Groups or filter them by Id.

SELECT * FROM Groups

If you're authenticated as an administrator with user impersonation permissions, you can query groups from multiple user accounts:

SELECT * FROM Groups WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query groups associated with their account.
Groups shared with multiple users are only returned for one of the users.

Insert

Only the Name column is required to create a Group.

INSERT INTO Groups (Name, Provenance, MemberViewabilityLevel) VALUES ('new group', 'google', 'admins_only')

Update

Any column where ReadOnly=False can be updated.

UPDATE Groups SET InvitabilityLevel = 'admins_and_members' WHERE Id = '111'

Delete

Groups can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Groups WHERE Id = '111'

Columns


Name	Type	ReadOnly	Description
ID [KEY]	String	True	The Id of the group.
Name	String	False	The name of the group.
Provenance	String	False	Typically used to track the external source where the group is coming from.
ExternalSyncIdentifier	String	False	Typically used as a group identifier for groups coming from an external source.
Description	String	False	The description of the group.
InvitabilityLevel	String	False	Specifies who can invite this group to folders.
MemberViewabilityLevel	String	False	Specifies who can view the members of this group.
CreatedAt	Datetime	True	The date the group was created at, you need to specify an Id to recieve this column.
ModifiedAt	Datetime	True	The date the group was modified at, you need to specify an Id to recieve this column.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

LegalPolicies

Query all legal hold policies that belong to an enterprise.

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	False	The Id of the legal hold policy.
AssignmentFileCount	Integer	True	The count for file assignments.
AssignmentFileVersionCount	Integer	True	The count for file version assignments.
AssignmentFolderCount	Integer	True	The count for folder assignments.
AssignmentUserCount	Integer	True	The count for user assignments.
CreatedAt	Datetime	True	The creation time of the policy.
CreatedById	String	True	The Id of the user that created the policy.
CreatedByLogin	String	True	The login of the user that created the policy.
CreatedByName	String	True	The name of the user that created the policy.
CreatedByType	String	True	The type of the user that created the policy.
DeletedAt	Datetime	True	The deletion time of the policy.
Description	String	False	The description of the policy.
FilterEndedAt	Datetime	False	The ending time of the filter.
FilterStartedAt	Datetime	False	The starting time of the filter.
ModifiedAt	Datetime	True	The modified time of the policy.
PolicyName	String	False	The name of the policy.
ReleaseNotes	String	False	The release notes for the policy.
Status	String	True	The status of the policy.
Type	String	True	The type of the policy.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.
IsOngoing	Boolean	False	Used only for INSERT statements. It defines whether new assignments under this policy should continue applying to files even after initialization.

Memberships

Create, update, delete, and query the available Memberships in Box.

Table Specific Information

Memberships are the relations between a User and a Group.

Select

To select from the Memberships table you need to specify an Id, a GroupId or a UserId.

SELECT * FROM Memberships WHERE Id = '123'

If you're authenticated as an administrator with user impersonation permissions, you can query memberships from multiple user accounts:

SELECT * FROM Memberships WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query memberships associated with their account.
Memberships shared with multiple users are only returned for one of the users.

Insert

To insert into Memberships you need to connect a Group (GroupId) with a User (UserId).

INSERT INTO Memberships (GroupId, UserId) VALUES (1001, 123)

Update

Only the role of the Member can be updated. The default role is 'member' with option for 'admin'

UPDATE Memberships SET Role = 'admin' WHERE Id = '100'

Delete

Memberships can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Memberships  WHERE Id = '100'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the membership.
Role	String	False	The role of the user that is in this membership.
CreatedAt	Datetime	True	The date the membership was created at, you need to specify an Id to recieve this column.
ModifiedAt	Datetime	True	The date the membership was modified at, you need to specify an Id to recieve this column.
UserName	String	True	The name of the user of the membership.
UserLogin	String	True	The login of the user of the membership.
UserId	String	False	The id of the user of the membership.
GroupName	String	False	The group name of the membership.
GroupId	String	False	The group of the membership.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

MetadataTemplates

Create, update, delete and query the Metadata Templates in Box

Table Specific Information

Select

You can retrieve information about the Metadata Template.

SELECT * FROM MetadataTemplates

You can also retrieve the information of any Template in your enterprise:

SELECT * FROM MetadataTemplates WHERE Id = 'e93746cc-03f6-4dee-ab45-01834989950c'

Insert

You can insert Metadata Template for your enterprise.

Insert a single field to the Template.

INSERT INTO MetadataTemplates (DisplayName, Scope, FieldsDisplayName, FieldsType) VALUES ('TestTemplate', 'enterprise', 'TestField', 'string')

Insert multiple fields to the Template.

INSERT INTO MetadataFields#TEMP (FieldDisplayName, FieldType, FieldOptions) VALUES ('Industry', 'enum', 'Technology, HealthCare')
INSERT INTO MetadataFields#TEMP (FieldDisplayName, FieldType) VALUES ('Contact Role', 'string')

INSERT INTO MetadataTemplates (DisplayName, Scope, FieldsAggregate) VALUES ('TestTemplate', 'enterprise', 'MetadataFields#TEMP')

Update

Add field to the existing Template.

UPDATE MetadataTemplates SET Op = 'addField', FieldsKey = 'category', FieldsDisplayName = 'Category', FieldsisHidden = false, FieldsType = 'string' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Update Fields in the Template.

UPDATE MetadataTemplates SET Op = 'editField', FieldsKey = 'Category', FieldsDescription = 'The Product Category' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

ReOrder Fields in the Template.

UPDATE MetadataTemplates SET Op = 'reorderFields', FieldsKey = 'Category,Industry,Contact' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Remove Fields from the Template.

UPDATE MetadataTemplates SET Op = 'removeField', FieldsKey = 'Industry' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Add Enum Options to the EnumField.

UPDATE MetadataTemplates SET Op = 'addEnumOption', FieldsKey = 'Industry', EnumOptionKey = 'AL' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

ReOrder Enum Options in the EnumField.

UPDATE MetadataTemplates SET Op = 'reorderEnumOptions', FieldsKey = 'industry', EnumOptionKey = 'AL,AK,AR,N/A' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Update Enum Options in the EnumField. Specify Present value, New value in the EnumOption column separated with comma.

UPDATE MetadataTemplates SET Op = 'editEnumOption', FieldsKey = 'industry', EnumOptionKey = 'N/A,Outside USA' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Remove Enum Options from the EnumField

UPDATE MetadataTemplates SET Op = 'removeEnumOption', FieldsKey = 'industry', EnumOptionKey = 'Outside USA' WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Delete

MetadataTemplates can be deleted by providing Scope and TemplateKey and issuing a DELETE statement.

DELETE FROM MetadataTemplates WHERE Scope = 'enterprise' AND TemplateKey = 'TestTemplate'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The ID of the metadata template.
TemplateKey	String	False	A unique identifier for the template. This identifier is unique across the scope of the enterprise to which the metadata template is being applied, yet is not necessarily unique across different enterprises
CopyInstanceOnItemCopy	Boolean	False	Whether or not to copy the metadata for a file or folder when an it is copied.
DisplayName	String	False	The display name of the template
FieldsId [KEY]	String	True	The Unique Id of the Metadata Template field
FieldsKey	String	False	A unique identifier for the field. The identifier must be unique within the template to which it belongs.
FieldsDisplayName	String	False	The display name of the field as it is shown to the user in the web and mobile apps.
FieldsType	String	False	The type of field
FieldsDescription	String	False	A description of the field
FieldsisHidden	Boolean	False	Whether this field is hidden in the UI for the user and can only be set through the API instead.
FieldsOptions	String	False	A list of options for this field. This is used in combination with the enum and multiSelect field types.
TemplateisHidden	Boolean	False	Defines if this template is visible in the Box web app UI, or if it is purely intended for usage through the API
Scope	String	False	The scope of the metadata template.
Type	String	True	Type of the template. Value is always metadata_template

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Op	String	The type of change to perform on the template. Some of these are hazardous as they will change existing templates. The allowed values are editTemplate, addField, reorderFields, addEnumOption, reorderEnumOptions, reorderMultiSelectOptions, addMultiSelectOption, editField, removeField, editEnumOption, removeEnumOption, editMultiSelectOption, removeMultiSelectOption.
EnumOptionKey	String	Update Only: For operations that affect multiple enum options this defines the keys of the options that are affected.
MultiSelectOptionKey	String	Update Only: For operations that affect multiple multi select options this defines the keys of the options that are affected.
FieldsAggregate	String	To insert more than one fields in the Template. The accepted columns are FieldsDisplayName, FieldsType, FieldsDescription, FieldsKey, FieldsisHidden, FieldsOptions

TaskAssignments

Create, update, delete, and query the available Task Assignments in Box.

Table Specific Information

Task Assignments are Tasks assigned to a specific User.

Select

To select from the TaskAssignments table you need to specify an Id or a TaskId.

SELECT * FROM TaskAssignments WHERE Id = '123'

If you're authenticated as an administrator with user impersonation permissions, you can query task assignments from multiple user accounts:

SELECT * FROM TaskAssignments WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query task assignments associated with their account.
Task assignments shared with multiple users are only returned for one of the users.

Insert

To insert into Task Assignments you need to connect a Task (TaskId) with a User (AssignedToId).

INSERT INTO TaskAssignments (TaskId, AssignedToId) VALUES (1001, 123)

Update

Only the Message of the Task Assignment or its ResolutionState can be updated.

UPDATE TaskAssignments SET Message = 'x', ResolutionState = 'completed' WHERE Id = '111'

Delete

Task Assignments can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM TaskAssignments WHERE Id = '111'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the task assignment.
TaskId	String	False	The Id of the task to assign.
AssignedToId	String	False	The Id of the user to assign the task to.
AssignedToName	String	False	The Name of the user the task is assigned to.
AssignedToLogin	String	False	The Login of the user the task is assigned to.
ItemType	String	False	The the type of the item the task assignment is connected to.
ItemId	String	False	The the id of the item the task assignment is connected to.
ItemName	String	False	The the name of the item the task assignment is connected to.
Message	String	False	The message attached to the task assignment.
AssignedById	String	False	The Id of the user that assigned the task.
AssignedByName	String	False	The Name of the user that assigned the task.
AssignedByLogin	String	False	The Login of the user that assigned the task.
AssignedAt	Datetime	True	The date the task was assigned at.
RemindedAt	Datetime	True	The date of the task reminder.
CompletedAt	Datetime	True	The date the task was completed at.
ResolutionState	String	False	Determines if the task has been attended to or not. The allowed values are completed, incomplete, approved, rejected.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Tasks

Create, update, delete, and query the available Tasks in Box.

Table Specific Information

Tasks are jobs that are waiting to be assigned to someone. These tasks are related to an item, which generally is a File.

Select

To select from the Tasks table you need to specify an Id or an ItemId.

SELECT * FROM Tasks WHERE Id = '123'

If you're authenticated as an administrator with user impersonation permissions, you can query tasks from multiple user accounts:

SELECT * FROM Tasks WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query tasks associated with their account.
Tasks shared with multiple users are only returned for one of the users.

Insert

ItemId is required to insert into Tasks table.Currently Box API supports only file as type of the item the task is for.

INSERT INTO Tasks (ItemId, ItemType, Action, Message) VALUES (1001, 'file', 'review', 'message')

Update

The Message is required to perform an UPDATE to a specific task. Also, the Action and DueAt columns can be updated as well. The Action column is only able to take a 'review' value.

UPDATE Tasks SET Message = 'updated message', Action = 'review', DueAt = '2016-05-14' WHERE ID = '100'

Delete

You can only delete a Task by providing an Id.

DELETE FROM Tasks WHERE Id = '100'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the task.
DueAt	Datetime	False	The date due of this task.
ItemId	String	False	The Id of the item the task is targeted to.
ItemType	String	False	The type of the item the task is targeted to.
Action	String	False	The action the task assignee will be prompted to do.
Message	String	False	An optional message to include with the task.
CreatedAt	Datetime	True	The date that the task was created at.
CreatedById	String	True	The id of user that created the task.
CreatedByName	String	True	The name of the user that created the task.
CreatedByLogin	String	True	The login of the user that created the task.
IsCompleted	Boolean	False	If the task has been completed or not.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

TrashedItems

Delete and query the available TrashedItems in Box.

Table Specific Information

TrashedItems are Files and Folders that have been deleted. This table supports only two operations: Select and Delete. Deleting from this table permanently deletes the File and is not recoverable.

Select

To search in the TrashedItems table for a specific item, specify the type of the item (File,Folder or WEB_LINK).

SELECT * FROM TrashedItems WHERE SearchTerms LIKE '%Untitled%' AND Type = 'file'

Or, if you want to query a single deleted Folder you could execute a query like the following:

SELECT * FROM TrashedItems WHERE Id = '123' AND Type = 'folder'

Or, if you want to query a single deleted Bookmark you could execute a query like the following:

SELECT * FROM TrashedItems WHERE Id = '123' AND Type = 'web_link'

Delete

TrashedItems can be deleted by specifying the Id and the Type of the item and issuing a DELETE statement.

DELETE FROM TrashedItems WHERE Id = 'abc123' AND Type = 'file'

Columns


Name	Type	ReadOnly	Description
SearchTerms	String	False	Query to search the trashed items database.
Id [KEY]	String	False	The Id of the trashed item.
Name	String	False	The name of the trashed item.
Type	String	False	The type of the item can be trashed item,folder or web_link.
Sha1	String	False	The SHA-1 encryption of the trashed item.
Etag	String	False	The Etag of the trashed item.
SequenceId	String	False	The sequence Id of the trashed item.
Description	String	False	The description of the trashed item.
Size	Integer	False	The size of the trashed item.
CreatedAt	Datetime	False	The date the trashed item was created at.
ModifiedAt	Datetime	False	The date the trashed item was modified at.
TrashedAt	Datetime	False	The date the trashed item was trashed at.
PurgedAt	Datetime	False	The date the trashed item was purged at.
ContentCreatedAt	Datetime	False	The date the content of the trashed item was created at.
ContentModifiedAt	Datetime	False	The date the content of the trashed item was modified at.
CreatedById	String	False	The Id of the user that created the trashed item.
CreatedByName	String	False	The Name of the user that created the trashed item..
CreatedByLogin	String	False	The Login of the user that created the trashed item..
SharedLink	String	False	The shared link of the user that created the trashed item.
ModifiedBy	String	False	The Id of the user that last modified the trashed item.
ModifiedByName	String	False	The Name of the user that last modified the trashed item..
ModifiedByLogin	String	False	The Login of the user that last modified the trashed item..
OwnedById	String	False	The Id of the user that owns the trashed item.
OwnedByName	String	False	The Name of the user that owns the trashed item..
OwnedByLogin	String	False	The Login of the user that owns the trashed item..
ParentId	String	False	The Id of the folder that contains the trashed item.
ItemStatus	String	False	The status of the trashed item.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
Scope	String	The scope of the search.
FileExtension	String	The extension of the trashed item.
SearchContent	String	The content to search the query at, separated by commas.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Users

Create, update, delete, and query the available Users in Box.

Table Specific Information

Select

You can retrieve information about the current User, a User in your enterprise specified by Id, or all the Users in the enterprise.

SELECT * FROM Users

You can also retrieve the information of any User who is in your enterprise:

SELECT * FROM Users WHERE Id = '1'

If you're authenticated as an administrator with user impersonation permissions, you can query users from multiple user accounts:

SELECT * FROM Users WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query users associated with their account.
Users shared with multiple users are only returned for one of the users.

Insert

You can invite a User to your enterprise. The following query will send an invitation email to join your enterprise.

INSERT INTO Users (Login, Name, Role) VALUES ('[email protected]', 'Username', 'coadmin')

Update

Any column where ReadOnly=False can be updated.

UPDATE Users SET Name = 'Test', Role = 'user', IsExemptFromDeviceLimits = false WHERE Id = '111'

Delete

Users can be deleted by providing an Id and issuing a DELETE statement.

DELETE FROM Users WHERE Id = '111'

Columns


Name	Type	ReadOnly	Description
Id [KEY]	String	True	The Id of the user. When selecting you can set this to the value me to retrieve information for the logged-user.
Login	String	False	The login of the user.
Name	String	False	The name of the user.
EnterpriseId	String	False	The id of the user's enterprise. Set this to null to disassociate the user from the enterprise.
Role	String	False	The role of the user.
Language	String	False	The preferred language of the user.
IsPlatformAccessOnly	Boolean	False	Indicates whether the user is an app user.
IsSyncEnabled	Boolean	False	If the user is allowed to use Box Sync or not.
JobTitle	String	False	The job title of the user.
Phone	String	False	The phone of the user.
Address	String	False	The address of the user.
SpaceAmount	Long	False	The amount of space the user is allowed to use.
SpaceUsed	Long	False	The amount of space the user has used.
MaxUploadSize	Long	False	The maximum upload size the user is allowed to upload.
TrackingCodes	String	False	The tracking codes of the user, separated by commas.
CanSeeManagedUsers	Boolean	False	The date the content of the user was created at.
TimeZone	String	False	The preferred timezone of the user.
IsExemptFromDeviceLimits	Boolean	False	If the user is exempt from device limitations or not.
IsExemptFromLoginVerification	Boolean	False	If the user is exempt from login verification or not.
Status	String	False	The status of the user.
IsPasswordResetRequired	Boolean	False	If the user should be asked to change his password on the next login or not.
CreatedAt	Datetime	True	The date the user was created.
ModifiedAt	Datetime	True	The date the user was modified.
AsUserId	String	False	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Views

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Box Connector for CData Sync Views


Name	Description
Collections	List Collections in Box.
FileMetadataInstances	Retrieves all metadata instances fields applied to a given file.
FileVersions	Query the available file versions in the box.
RecentItems	List RecentItems in Box.
SharedItems	Query the available shared items in Box.
SignRequests	List all Sign Requests.
UserEvents	Query the available Events in Box.

Collections

List Collections in Box.

Columns


Name	Type	Description
Id	String	The unique identifier for this collection.
Name	String	The name of the collection.
Type	String	The type of the collection.
CollectionType	String	The type of the collection. This is used to determine the proper visual treatment for collections.

FileMetadataInstances

Retrieves all metadata instances fields applied to a given file.

Columns


Name	Type	Description
Id	String	A UUID to identify the metadata instance.
FileId [KEY]	String	The ID of the file.
Template	String	The name of the template.
Parent	String	The identifier of the item that this metadata instance has been attached to. This combines the type and the id of the parent in the form {type}_{id}.
Scope	String	An ID for the scope in which this template has been applied. This will be enterprise_{enterprise_id} for templates defined for use in this enterprise, and global for general templates that are available to all enterprises using Box.
Version	String	The version of the metadata instance. This version starts at 0 and increases every time a user-defined property is modified.
CanEdit	String	Whether the user can edit this metadata instance.
Type	String	A unique identifier for the type.
TypeVersion	String	The last-known version of the template of the object.
UserDefinedFieldName	String	The user-defined field name.
UserDefinedFieldValue	String	The value of the user defined field.

FileVersions

Query the available file versions in the box.

Table Specific Information

File Versions contains information about older versions of a file. This table supports only SELECT operation.

Select

FileId is required to search all the FileVersions in your files.

SELECT * FROM FileVersions WHERE FileId = '585442984153'

If you're authenticated as an administrator with user impersonation permissions, you can query file versions from multiple user accounts:

SELECT * FROM FileVersions WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query file versions associated with their account.
File versions shared with multiple users are only returned for one of the users.

Columns


Name	Type	Description
Id [KEY]	String	The ID of the file version.
FileId	String	The ID of the file.
CreatedAt	Datetime	The date the content of the file was created at.
ModifiedAt	Datetime	The date the content of the file was modified at.
ModifiedById	String	The Id of the user that last modified the file.
ModifiedByName	String	The Name of the user that last modified the file.
ModifiedByLogin	String	The Login of the user that last modified the file.
ModifiedByType	String	The Type of the user that last modified the file.
Name	String	The name of the file.
PurgedAt	Datetime	The date the content of the file was purged at.
RestoredAt	Datetime	The date the content of the file was modified at.
RestoredById	String	The Id of the user that last modified the file.
RestoredByLogin	String	The Name of the user that last modified the file.
RestoredByName	String	The Login of the user that last modified the file.
RestoredByType	String	The Type of the user that last modified the file.
Sha1	String	The SHA-1 encryption of the file version.
Size	Int64	The size of the file version.
TrashedAt	Datetime	The date the file version was trashed at.
TrashedById	String	The Id of the user that trashed the file.
TrashedByLogin	String	The Name of the user that trashed the file.
TrashedByName	String	The Login of the user that trashed the file.
TrashedByType	String	The Type of the user that trashed the file.
Type	String	Type of file versions.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

RecentItems

List RecentItems in Box.

Columns


Name	Type	Description
Type	String	The type of the recent item.
InteractedAt	Datetime	The time of the most recent interaction.
InteractionSharedLink	String	If the item was accessed through a shared link it will appear here, otherwise this will be null.
InteractionType	String	The most recent type of access the user performed on the item.
ItemId	String	The unique identifier for the recent item.

SharedItems

Query the available shared items in Box.

Table Specific Information

Shared Items are Files that are open to public viewing by using a URL. These files can also be password protected. Anyone who has access to this URL and password would be able to read/write to the file.

Select

To select from SharedItems specify the SharedLink that points to the item.

SELECT * FROM SharedItems WHERE SharedLink = 'www.url.com'

If the SharedItem has a password also specify the password.

SELECT * FROM SharedItems WHERE SharedLink = 'www.url.com' AND SharedLinkPassword = 'password'

If you're authenticated as an administrator with user impersonation permissions, you can query shared items from multiple user accounts:

SELECT * FROM SharedItems WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query shared items associated with their account.
Shared items shared with multiple users are only returned for one of the users.

Columns


Name	Type	Description
Name	String	The name of the shared item.
ItemId [KEY]	String	The Id of the shared item.
ItemType	String	The item type that the shared item points to.
CreatedAt	String	The date the shared item was created at.
Description	String	The description of the of the shared item.
ModifiedAt	String	The date the shared item was modified at.
OwnedById	String	The id of owner of the shared item.
OwnedByName	String	The name of owner of the shared item.
OwnedByLogin	String	The login of owner of the shared item.
ParentId	String	The id of the parent of the shared item.
ParentName	String	The Name of the parent of the shared item.
Access	String	The availability of the shared item.
DownloadCount	Integer	The number of times the item was downloaded
DownloadUrl	String	The url to download the item from.
IsPasswordEnabled	String	If you need to specify a password to download the file or not.
CanDownload	Boolean	If the item is available to download or not.
CanPreview	Boolean	If the item is available to preview or not.
PreviewCount	Integer	The number of times the item was previewed.
Url	String	The preview url of the item.
Size	Long	The size of the item.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
SharedLink	String	The shared link to query.
SharedLinkPassword	String	The password of shared link.

SignRequests

List all Sign Requests.

Columns


Name	Type	Description
SignRequestAggregate	String	A JSON Aggregate representing the SignRequest item.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

UserEvents

Query the available Events in Box.

Table Specific Information

User events are logs that are saved after a change in a user's account.

Select

Query all the current user's events:

SELECT * FROM UserEvents

If you're authenticated as an administrator with user impersonation permissions, you can query user events from multiple user accounts:

SELECT * FROM UserEvents WHERE AsUserId IN (SELECT Id FROM Users)

Note: User impersonation has the following limitations:

The authenticated user cannot be impersonated unless that user is a service account.
If the authenticated user is a standard user account, they can only query user events associated with their account.
User events shared with multiple users are only returned for one of the users.

Columns


Name	Type	Description
Id [KEY]	String	The Id of the event.
SourceId	String	The Id of the source that triggered the event.
SourceType	String	The type of the source that triggered the event.
CreatedById	String	The Id of the user that created the event.
CreatedByName	String	The Name of the user that created the event.
CreatedByLogin	String	The Login of the user that created the event.
CreatedAt	Datetime	The date the event was created at. This can only be used when requesting the events with a StreamType of admin_logs
RecordedAt	Datetime	The date the event was recorded at.
SessionId	String	The Id of the session of the event.
EventType	String	The type of the event.
ClassificationName	String	The classification name of the event.
AdditionalDetails	String	This object provides additional information about the event if available. This can include how a user performed an event as well as additional information to correlate an event to external KeySafe logs. Not all events have an additional_details object. This object is only available in the Enterprise Events.
AsUserId	String	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.


Name	Type	Description
StreamType	String	The type of events to stream. The allowed values are all, changes, sync, admin_logs, admin_logs_streaming.

Connection String Options

The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.

For more information on establishing a connection, see Establishing a Connection.

Authentication

Property	Description
AuthScheme	The type of authentication to use when connecting to Box.
ImpersonateUserMode	Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

JWT OAuth

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.
OAuthJWTSubjectType	The SubType for the JWT authentication.
OAuthJWTPublicKeyId	The Id of the public key for JWT.

OAuth

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
SubjectId	The user subject for which the application is requesting delegated access.
SubjectType	The Subject Type for the Client Credentials authentication.

SSL

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Firewall

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

Proxy

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Logging

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Schema

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Miscellaneous

Property	Description
AsUserId	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.
DirectoryRetrievalDepth	Depth level of folder to query Folders and Files tables.
ExposeCollectionViews	Determines whether to expose every collection in your Box account as separate views.
IncludeCustomFields	Set to true if metadata templates should be exposed as custom columns of the table Files.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Authentication

This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.

Property	Description
AuthScheme	The type of authentication to use when connecting to Box.
ImpersonateUserMode	Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

AuthScheme

The type of authentication to use when connecting to Box.

Remarks

OAuth: Set this to perform OAuth authentication using a standard user account.
OAuthJWT: Set this to perform OAuth authentication using an OAuth service account.
OAuthClient: Set this to perform Client Credentials authentication.

ImpersonateUserMode

Specify the type of the user impersonation. It should be whether the User mode or the Admin mode.

Remarks

Specify the type of the user impersonation. It should be whether the User mode or the Admin mode. The Admin mode is available only for Enterprise with Governance accounts and will be upon request. It will not work for any other accounts.

JWT OAuth

This section provides a complete list of the JWT OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthJWTCert	The JWT Certificate store.
OAuthJWTCertType	The type of key store containing the JWT Certificate.
OAuthJWTCertPassword	The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.
OAuthJWTCertSubject	The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.
OAuthJWTIssuer	The issuer of the Java Web Token.
OAuthJWTSubject	The user subject for which the application is requesting delegated access.
OAuthJWTSubjectType	The SubType for the JWT authentication.
OAuthJWTPublicKeyId	The Id of the public key for JWT.

OAuthJWTCert

The JWT Certificate store.

Remarks

The name of the certificate store for the client certificate.

The OAuthJWTCertType field specifies the type of the certificate store specified by OAuthJWTCert. If the store is password protected, specify the password in OAuthJWTCertPassword.

OAuthJWTCert is used in conjunction with the OAuthJWTCertSubject field in order to specify client certificates. If OAuthJWTCert has a value, and OAuthJWTCertSubject is set, a search for a certificate is initiated. Please refer to the OAuthJWTCertSubject field for details.

Designations of certificate stores are platform-dependent.

The following are designations of the most common User and Machine certificate stores in Windows:


MY	A certificate store holding personal certificates with their associated private keys.
CA	Certifying authority certificates.
ROOT	Root certificates.
SPC	Software publisher certificates.

In Java, the certificate store normally is a file containing certificates and optional private keys.

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

OAuthJWTCertType

The type of key store containing the JWT Certificate.

Remarks

This property can take one of the following values:


USER	For Windows, this specifies that the certificate store is a certificate store owned by the current user. Note: This store type is not available in Java.
MACHINE	For Windows, this specifies that the certificate store is a machine store. Note: this store type is not available in Java.
PFXFILE	The certificate store is the name of a PFX (PKCS12) file containing certificates.
PFXBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in PFX (PKCS12) format.
JKSFILE	The certificate store is the name of a Java key store (JKS) file containing certificates. Note: this store type is only available in Java.
JKSBLOB	The certificate store is a string (base-64-encoded) representing a certificate store in Java key store (JKS) format. Note: this store type is only available in Java.
PEMKEY_FILE	The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate.
PEMKEY_BLOB	The certificate store is a string (base64-encoded) that contains a private key and an optional certificate.
PUBLIC_KEY_FILE	The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate.
PUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains a PEM- or DER-encoded public key certificate.
SSHPUBLIC_KEY_FILE	The certificate store is the name of a file that contains an SSH-style public key.
SSHPUBLIC_KEY_BLOB	The certificate store is a string (base-64-encoded) that contains an SSH-style public key.
P7BFILE	The certificate store is the name of a PKCS7 file containing certificates.
PPKFILE	The certificate store is the name of a file that contains a PPK (PuTTY Private Key).
XMLFILE	The certificate store is the name of a file that contains a certificate in XML format.
XMLBLOB	The certificate store is a string that contains a certificate in XML format.
BCFKSFILE	The certificate store is the name of a file that contains an Bouncy Castle keystore.
BCFKSBLOB	The certificate store is a string (base-64-encoded) that contains a Bouncy Castle keystore.
BOXJSON	The certificate store is the name of a JSON file containing the service account credentials. Only valid when connecting to Box.
BOXJSONBLOB	The certificate store is a string that contains the service account JSON. Only valid when connecting to Box.

OAuthJWTCertPassword

The password for the OAuth JWT certificate used to access a certificate store that requires a password. If the certificate store does not require a password, leave this property blank.

Remarks

This property specifies the password needed to open the certificate store, but only if the store type requires one. To determine if a password is necessary, refer to the documentation or configuration for your specific certificate store.

OAuthJWTCertSubject

The subject of the OAuth JWT certificate used to locate a matching certificate in the store. Supports partial matches and the wildcard '*' to select the first certificate.

Remarks

The value of this property is used to locate a matching certificate in the store. The search process works as follows:

If an exact match for the subject is found, the corresponding certificate is selected.
If no exact match is found, the store is searched for certificates whose subjects contain the property value.
If no match is found, no certificate is selected.

You can set the value to '*' to automatically select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For example: CN=www.server.com, OU=test, C=US, [email protected]. Common fields include:


Field	Meaning
CN	Common Name. This is commonly a host name like www.server.com.
O	Organization
OU	Organizational Unit
L	Locality
S	State
C	Country
E	Email Address

If a field value contains a comma, enclose it in quotes. For example: "O=ACME, Inc.".

OAuthJWTIssuer

The issuer of the Java Web Token.

Remarks

The issuer of the Java Web Token. This is typically either the Client Id or Email Address of the OAuth Application.

OAuthJWTSubject

The user subject for which the application is requesting delegated access.

Remarks

The user subject for which the application is requesting delegated access. Typically, the user account name or email address.

OAuthJWTSubjectType

The SubType for the JWT authentication.

Remarks

The SubType for the JWT authentication. Set this to "enterprise" or "user" depending on the type of token being requested.

OAuthJWTPublicKeyId

The Id of the public key for JWT.

Remarks

The Id of the public key for JWT. Set this to the value of your Public Key Id in your app settings.

OAuth

This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.

Property	Description
OAuthClientId	Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.
OAuthClientSecret	Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.
SubjectId	The user subject for which the application is requesting delegated access.
SubjectType	The Subject Type for the Client Credentials authentication.

OAuthClientId

Specifies the client Id that was assigned the custom OAuth application was created. (Also known as the consumer key.) This ID registers the custom application with the OAuth authorization server.

Remarks

OAuthClientId is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

OAuthClientSecret

Specifies the client secret that was assigned when the custom OAuth application was created. (Also known as the consumer secret ). This secret registers the custom application with the OAuth authorization server.

Remarks

OAuthClientSecret is one of a handful of connection parameters that need to be set before users can authenticate via OAuth. For details, see Establishing a Connection.

SubjectId

The user subject for which the application is requesting delegated access.

Remarks

Id of the user or enterprise, based on the configuration set in SubjectType.

SubjectType

The Subject Type for the Client Credentials authentication.

Remarks

The Subject Type for the Client Credentials authentication. Set this to "enterprise" or "user" depending on the type of token being requested.

SSL

This section provides a complete list of the SSL properties you can configure in the connection string for this provider.

Property	Description
SSLServerCert	Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

SSLServerCert

Specifies the certificate to be accepted from the server when connecting using TLS/SSL.

Remarks

If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.

This property can take the following forms:


Description	Example
A full PEM Certificate (example shortened for brevity)	-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----
A path to a local file containing the certificate	C:\cert.cer
The public key (example shortened for brevity)	-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----
The MD5 Thumbprint (hex values can also be either space or colon separated)	ecadbdda5a1529c58a1e9e09828d70e4
The SHA1 Thumbprint (hex values can also be either space or colon separated)	34a929226ae0819f2ec14b4a3d904f801cbb150d

If not specified, any certificate trusted by the machine is accepted.

Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.

Firewall

This section provides a complete list of the Firewall properties you can configure in the connection string for this provider.

Property	Description
FirewallType	Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.
FirewallServer	Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.
FirewallPort	Specifies the TCP port to be used for a proxy-based firewall.
FirewallUser	Identifies the user ID of the account authenticating to a proxy-based firewall.
FirewallPassword	Specifies the password of the user account authenticating to a proxy-based firewall.

FirewallType

Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Note: By default, the Sync App connects to the system proxy. To disable this behavior and connect to one of the following proxy types, set ProxyAutoDetect to false.

The following table provides port number information for each of the supported protocols.


Protocol	Default Port	Description
TUNNEL	80	The port where the Sync App opens a connection to Box. Traffic flows back and forth via the proxy at this location.
SOCKS4	1080	The port where the Sync App opens a connection to Box. SOCKS 4 then passes theFirewallUser value to the proxy, which determines whether the connection request should be granted.
SOCKS5	1080	The port where the Sync App sends data to Box. If the SOCKS 5 proxy requires authentication, set FirewallUser and FirewallPassword to credentials the proxy recognizes.

To connect to HTTP proxies, use ProxyServer and ProxyPort. To authenticate to HTTP proxies, use ProxyAuthScheme, ProxyUser, and ProxyPassword.

FirewallServer

Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPort

Specifies the TCP port to be used for a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallUser

Identifies the user ID of the account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

FirewallPassword

Specifies the password of the user account authenticating to a proxy-based firewall.

Remarks

A proxy-based firewall (or proxy firewall) is a network security device that acts as an intermediary between user requests and the resources they access. The proxy accepts the request of an authenticated user, tunnels through the firewall, and transmits the request to the appropriate server.

Because the proxy evaluates and transfers data backets on behalf of the requesting users, the users never connect directly with the servers, only with the proxy.

Proxy

This section provides a complete list of the Proxy properties you can configure in the connection string for this provider.

Property	Description
ProxyAutoDetect	Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.
ProxyServer	The hostname or IP address of the proxy server that you want to route HTTP traffic through.
ProxyPort	The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.
ProxyAuthScheme	Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.
ProxyUser	The username of a user account registered with the proxy server specified in the ProxyServer connection property.
ProxyPassword	The password associated with the user specified in the ProxyUser connection property.
ProxySSLType	The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.
ProxyExceptions	A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

ProxyAutoDetect

Specifies whether the provider checks your system proxy settings for existing proxy server configurations, rather than using a manually specified proxy server.

Remarks

When this connection property is set to True, the Sync App checks your system proxy settings for existing proxy server configurations (no need to manually supply proxy server details).

This connection property takes precedence over other proxy settings. Set to False if you want to manually configure the Sync App to connect to a specific proxy server.

To connect to an HTTP proxy, see ProxyServer. For other proxies, such as SOCKS or tunneling, see FirewallType.

ProxyServer

The hostname or IP address of the proxy server that you want to route HTTP traffic through.

Remarks

The Sync App only routes HTTP traffic through the proxy server specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server specified in your system proxy settings.

ProxyPort

The TCP port on your specified proxy server (set in the ProxyServer connection property) that has been reserved for routing HTTP traffic to and from the client.

Remarks

The Sync App only routes HTTP traffic through the proxy server port specified in this connection property when ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead routes HTTP traffic through the proxy server port specified in your system proxy settings.

For other proxy types, see FirewallType.

ProxyAuthScheme

Specifies the authentication method the provider uses when authenticating to the proxy server specified in the ProxyServer connection property.

Remarks

The authentication type can be one of the following:

BASIC: The Sync App performs HTTP BASIC authentication.
DIGEST: The Sync App performs HTTP DIGEST authentication.
NTLM: The Sync App retrieves an NTLM token.
NEGOTIATE: The Sync App retrieves an NTLM or Kerberos token based on the applicable protocol for authentication.
NONE: Set this when the ProxyServer does not require authentication.

For all values other than "NONE", you must also set the ProxyUser and ProxyPassword connection properties.

If you need to use another authentication type, such as SOCKS 5 authentication, see FirewallType.

ProxyUser

The username of a user account registered with the proxy server specified in the ProxyServer connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyUser
BASIC	The user name of a user registered with the proxy server.
DIGEST	The user name of a user registered with the proxy server.
NEGOTIATE	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NTLM	The username of a Windows user who is a valid user in the domain or trusted domain that the proxy server is part of, in the format `user@domain` or `domain\user`.
NONE	Do not set the ProxyPassword connection property.

The Sync App only uses this username if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the username specified in your system proxy settings.

ProxyPassword

The password associated with the user specified in the ProxyUser connection property.

Remarks

The ProxyUser and ProxyPassword connection properties are used to connect and authenticate against the HTTP proxy specified in ProxyServer.

After selecting one of the available authentication types in ProxyAuthScheme, set this property as follows:


ProxyAuthScheme Value	Value to set for ProxyPassword
BASIC	The password associated with the proxy server user specified in ProxyUser.
DIGEST	The password associated with the proxy server user specified in ProxyUser.
NEGOTIATE	The password associated with the Windows user account specified in ProxyUser.
NTLM	The password associated with the Windows user account specified in ProxyUser.
NONE	Do not set the ProxyPassword connection property.

For SOCKS 5 authentication or tunneling, see FirewallType.

The Sync App only uses this password if ProxyAutoDetect is set to False. If ProxyAutoDetect is set to True, which is the default, the Sync App instead uses the password specified in your system proxy settings.

ProxySSLType

The SSL type to use when connecting to the proxy server specified in the ProxyServer connection property.

Remarks

This property determines when to use SSL for the connection to the HTTP proxy specified by ProxyServer. You can set this connection property to the following values :


AUTO	Default setting. If ProxyServer is set to an HTTPS URL, the Sync App uses the TUNNEL option. If ProxyServer is set to an HTTP URL, the component uses the NEVER option.
ALWAYS	The connection is always SSL enabled.
NEVER	The connection is not SSL enabled.
TUNNEL	The connection is made through a tunneling proxy. The proxy server opens a connection to the remote host and traffic flows back and forth through the proxy.

ProxyExceptions

A semicolon separated list of destination hostnames or IPs that are exempt from connecting through the proxy server set in the ProxyServer connection property.

Remarks

The ProxyServer is used for all addresses, except for addresses defined in this property. Use semicolons to separate entries.

Note that the Sync App uses the system proxy settings by default, without further configuration needed. If you want to explicitly configure proxy exceptions for this connection, set ProxyAutoDetect to False.

Logging

This section provides a complete list of the Logging properties you can configure in the connection string for this provider.

Property	Description
LogModules	Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

LogModules

Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged.

Remarks

This property lets you customize the log file content by specifying the logging modules to include. Logging modules categorize logged information into distinct areas, such as query execution, metadata, or SSL communication. Each module is represented by a four-character code, with some requiring a trailing space for three-letter names.

For example, EXEC logs query execution, and INFO logs general provider messages. To include multiple modules, separate their names with semicolons as follows: INFO;EXEC;SSL.

The Verbosity connection property takes precedence over the module-based filtering specified by this property. Only log entries that meet the verbosity level and belong to the specified modules are logged. Leave this property blank to include all available modules in the log file.

For a complete list of available modules and detailed guidance on configuring logging, refer to the Advanced Logging section in Logging.

Schema

This section provides a complete list of the Schema properties you can configure in the connection string for this provider.

Property	Description
Location	Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.
BrowsableSchemas	Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
Tables	Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .
Views	Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Location

Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path.

Remarks

The Location property is only needed if you want to either customize definitions (for example, change a column name, ignore a column, etc.) or extend the data model with new tables, views, or stored procedures.

If left unspecified, the default location is %APPDATA%\\CData\\Box Data Provider\\Schema, where %APPDATA% is set to the user's configuration directory:


Platform	%APPDATA%
Windows	The value of the APPDATA environment variable
Linux	~/.config

BrowsableSchemas

Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .

Remarks

Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.

Tables

Optional setting that restricts the tables reported to a subset of all available tables. For example, Tables=TableA,TableB,TableC .

Remarks

Listing all available tables from some databases can take extra time, thus degrading performance. Providing a list of tables in the connection string saves time and improves performance.

If there are lots of tables available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those tables. To do this, specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each table you want to view by its fully qualified name. This avoids ambiguity between tables that may exist in multiple catalogs or schemas.

Views

Optional setting that restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC .

Remarks

Listing all available views from some databases can take extra time, thus degrading performance. Providing a list of views in the connection string saves time and improves performance.

If there are lots of views available and you already know which ones you want to work with, you can use this property to restrict your viewing to only those views. To do this, specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Note: If you are connecting to a data source with multiple schemas or catalogs, you must specify each view you want to examine by its fully qualified name. This avoids ambiguity between views that may exist in multiple catalogs or schemas.

Miscellaneous

This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.

Property	Description
AsUserId	The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.
DirectoryRetrievalDepth	Depth level of folder to query Folders and Files tables.
ExposeCollectionViews	Determines whether to expose every collection in your Box account as separate views.
IncludeCustomFields	Set to true if metadata templates should be exposed as custom columns of the table Files.
MaxRows	Specifies the maximum rows returned for queries without aggregation or GROUP BY.
Other	Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.
PseudoColumns	Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.
Timeout	Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.
UserDefinedViews	Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

AsUserId

The Id of the user you want to impersonate. Only works with Admin, Co-Admin and Service Accounts.

Remarks

If you specify a user id for this property, you can act on behalf of another user by leveraging the as-user Box header. The values specified in the pseudo-columns of tables/views or the values specified in stored procedures parameters take higher precedence over the value specified in this property.

DirectoryRetrievalDepth

Depth level of folder to query Folders and Files tables.

Remarks

This property must be set in the connection string or the driver will use a default of Depth=5.

ExposeCollectionViews

Determines whether to expose every collection in your Box account as separate views.

Remarks

If you set this property to 'true', you can query files and folders from the corresponding Box collection.

IncludeCustomFields

Set to true if metadata templates should be exposed as custom columns of the table Files.

Remarks

Set to true if metadata templates should be exposed as custom columns of the table Files.

MaxRows

Specifies the maximum rows returned for queries without aggregation or GROUP BY.

Remarks

This property sets an upper limit on the number of rows the Sync App returns for queries that do not include aggregation or GROUP BY clauses. This limit ensures that queries do not return excessively large result sets by default.

When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting. If MaxRows is set to "-1", no row limit is enforced unless a LIMIT clause is explicitly included in the query.

This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.

Other

Specifies additional hidden properties for specific use cases. These are not required for typical provider functionality. Use a semicolon-separated list to define multiple properties.

Remarks

This property allows advanced users to configure hidden properties for specialized scenarios. These settings are not required for normal use cases but can address unique requirements or provide additional functionality. Multiple properties can be defined in a semicolon-separated list.

Note: It is strongly recommended to set these properties only when advised by the support team to address specific scenarios or issues.

Specify multiple properties in a semicolon-separated list.

Integration and Formatting


DefaultColumnSize	Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000.
ConvertDateTimeToGMT	Determines whether to convert date-time values to GMT, instead of the local time of the machine.
RecordToFile=filename	Records the underlying socket data transfer to the specified file.

PseudoColumns

Specifies the pseudocolumns to expose as table columns. Use the format 'TableName=ColumnName;TableName=ColumnName'. The default is an empty string, which disables this property.

Remarks

This property allows you to define which pseudocolumns the Sync App exposes as table columns.

To specify individual pseudocolumns, use the following format: "Table1=Column1;Table1=Column2;Table2=Column3"

To include all pseudocolumns for all tables use: "*=*"

Timeout

Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. The default is 60 seconds. Set to 0 to disable the timeout.

Remarks

This property controls the maximum time, in seconds, that the Sync App waits for an operation to complete before canceling it. If the timeout period expires before the operation finishes, the Sync App cancels the operation and throws an exception.

The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.

Setting this property to 0 disables the timeout, allowing operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server. Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.

UserDefinedViews

Specifies a filepath to a JSON configuration file defining custom views. The provider automatically detects and uses the views specified in this file.

Remarks

This property allows you to define and manage custom views through a JSON-formatted configuration file called UserDefinedViews.json. These views are automatically recognized by the Sync App and enable you to execute custom SQL queries as if they were standard database views. The JSON file defines each view as a root element with a child element called "query", which contains the SQL query for the view. For example:

{
	"MyView": {
		"query": "SELECT * FROM Files WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

You can define multiple views in a single file and specify the filepath using this property. For example: UserDefinedViews=C:\Path\To\UserDefinedViews.json. When you use this property, only the specified views are seen by the Sync App.

Refer to User Defined Views for more information.

Box Connector for CData Sync

Box Connector for CData Sync

Overview

Box Version Support

Establishing a Connection

Adding a Connection to Box

Connecting to Box

Authenticating to Box

User Accounts (OAuth)

Service Account (OAuthJWT)

BOXJSON OAuthJWTCertType

Advanced Features

User Defined Views

SSL Configuration

Firewall and Proxy

Query Processing

Logging

SSL Configuration

Customizing the SSL Configuration

Firewall and Proxy

Connecting Through a Firewall or Proxy

HTTP Proxies

Other Proxies

Data Model

Tables

Views

Stored Procedures

Dynamic Collection Views

Tables

Box Connector for CData Sync Tables

Bookmarks

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Collaborations

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Comments

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Files

Table Specific Information

Select

Update

Delete

Columns

Pseudo-Columns

Folders

Table Specific Information

Select

Insert

Update

Delete

Columns

Pseudo-Columns

Groups

Table Specific Information

Select

Insert

Update

Delete

Columns

LegalPolicies

Columns

Memberships

Table Specific Information