Box v2
Box Pack.#
This Integration is part of theManage Box users This integration was integrated and tested with API version 2.0 of Box v2
#
Configure the Box Application to Interface with XSOAR- Navigate to the developer console for Box.
- Click Create a New App.
- Select Custom App and when prompted, select Server Authentication (with JWT)
- Enter your desired App Name.
- In the Configuration menu under Application Access, select Enterprise.
- Under the Advanced Features option, enable both Perform Actions as Users and Generate User Access Tokens.
- In the Add and Manage Public Keys section, click Generate a Public/Private Keypair and follow the prompts.
- Click Save Changes in the upper right-hand corner.
- Navigate to the bottom of the page and select Download as a JSON.
Once you have obtained the JSON file, copy and paste its contents into the Credentials JSON parameter.
Before testing the integration, navigate to the General Settings for your app in the developer console and click Review and Submit. Your enterprise admin will need to approve the app before your integration will start working.
From the General Settings menu, you may also obtain your User ID for the service account.
#
Configure Box v2 on Cortex XSOARNavigate to Settings > Integrations > Servers & Services.
Search for Box v2.
Click Add instance to create and configure a new integration instance.
Parameter Description Required insecure Trust any certificate (not secure) False credentials_json Credentials JSON True as_user As User for Fetching Incidents False event_type False default_user Default User False search_user_id Auto-detect user IDs based on their email address. False incidentType Incident type False isFetch Fetch incidents False first_fetch First fetch timestamp ( <number>
<time unit>
, e.g., 12 hours, 7 days)False max_fetch False Click Test to validate the URLs, token, and connection.
#
Differences between Box (Deprecated) and Box v2- Context outputs were changed to be nested under the entity type for each command. For example, user outputs used to be stored under the context root, Box. In this version they are stored under the entity Box.Users.
- Authentication is handled via JSON Web Tokens (JWT) and no longer requires each command to retrieve an authentication token manually.
- All results given via the Box API is returned into the context.
#
CommandsYou can execute these commands from the Cortex XSOAR CLI, as part of an automation, or in a playbook. After you successfully execute a command, a DBot message appears in the War Room with the command details.
#
box-search-contentSearches for files, folders, web links, and shared files across the users content or across the entire enterprise.
#
Base Commandbox-search-content
#
InputArgument Name | Description | Required |
---|---|---|
type | Limits the search results to any items of this type. This parameter only takes one value. By default the API returns items that match any of these types. Possible values are: file, folder, web_link. | Optional |
ancestor_folder_ids | A comma-separated lists of folder IDs that limits the search results to items within the given list of folders. | Optional |
item_name | Query for an item by name. | Optional |
item_description | The description of the item to search for. | Optional |
comments | The comments of the item to search for. | Optional |
tag | The tag of the item to search for. | Optional |
created_range | A comma-separated list of the time frame of when the item was created. Can be RFC3339 timestamps, or relative to the current time (e.g., 3 Days). | Optional |
file_extensions | Limits the search results to any files that match any of the provided file extensions. | Optional |
limit | The maximum number of items to return as part of a page of results. Default is "100". | Optional |
offset | The offset of the item at which to begin the response. Default is "0". | Optional |
owner_uids | A comma-separated list of user IDs used to limit the search results to any items that are owned by the given list of owners. | Optional |
trash_content | Whether the search should look in the trash for items. | Optional |
updated_at_range | Limits the search results to any items updated within a given date range. | Optional |
query | The string to search for. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.Query.id | Number | The ID of the item found. |
Box.Query.etag | Number | The entry tag for the item found. |
Box.Query.type | String | The type of the item found. |
Box.Query.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Query.name | String | The name of the item. |
Box.Query.sha1 | String | The SHA1 hash of the item. |
Box.Query.file_version.id | Number | The unique identifier that represent a file version. |
Box.Query.file_version.type | String | Value is always file_version. |
Box.Query.file_version.sha1 | String | The SHA1 hash of this version of the file. |
Box.Query.description | String | The description of the item. |
Box.Query.size | Number | The file size in bytes. |
Box.Query.path_collection.total_count | Number | The number of folders in the list. |
Box.Query.path_collection.entries.id | Number | The ID of the item found. |
Box.Query.path_collection.entries.etag | Number | The entry tag for the item found. |
Box.Query.path_collection.entries.type | String | The type of the item found. |
Box.Query.path_collection.entries.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Query.path_collection.entries.name | String | The name of the item. |
Box.Query.created_at | Date | The date and time when the item was created on Box. |
Box.Query.modified_at | Date | The date and time when the item was last updated on Box. |
Box.Query.trashed_at | Date | The time at which the item was put in the trash. |
Box.Query.purged_at | Date | The time at which the item is expected to be purged from the trash. |
Box.Query.content_created_at | Date | The date and time at which the item was originally created, which might be before it was uploaded to Box. |
Box.Query.content_modified_at | Date | The date and time at which the item was last updated, which might be before it was uploaded to Box. |
Box.Query.created_by.id | Number | The unique identifier for the user who created the item. |
Box.Query.created_by.type | String | Value is always user. |
Box.Query.created_by.name | String | The display name of the user who created the item. |
Box.Query.created_by.login | String | The primary email address of the user who created the item. |
Box.Query.modified_by.id | Number | The unique identifier for the user who modified the item. |
Box.Query.modified_by.type | String | Value is always user. |
Box.Query.modified_by.name | String | The display name of the user who modified the item. |
Box.Query.modified_by.login | String | The primary email address of the user who modified the item. |
Box.Query.owned_by.id | Number | The unique identifier for the user who owns the item. |
Box.Query.owned_by.type | String | Value is always user. |
Box.Query.owned_by.name | String | The display name of the user who owns the item. |
Box.Query.owned_by.login | String | The primary email address of the user who owns the item. |
Box.Query.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.Query.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.Query.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.Query.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.Query.entries.shared_link.access | String | The access level for the shared link. |
Box.Query.shared_link.effective_access | String | The effective access level for the shared link. |
Box.Query.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.Query.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.Query.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.Query.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.Query.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.Query.entries.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.Query.shared_link.preview_count | Number | The number of times the item has been previewed. |
Box.Query.parent.id | Number | The ID of the parent for the item found |
Box.Query.parent.etag | Number | The entry tag for the parent of the item found. |
Box.Query.parent.type | String | The type for the parent of the item found. |
Box.Query.parent.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the parent of the item. |
Box.Query.parent.name | String | The name of the parent of the item. |
Box.Query.item_status | String | The status of the parent of the item. |
#
Command Example!box-search-content item_name="test" limit="1"
#
Context Example#
Human Readable Output#
Search results
Content Created At Content Modified At Created At Created By Etag Id Item Status Modified At Modified By Name Owned By Parent Path Collection Sequence Id Size Type 2020-11-30T03:53:45-08:00 2020-11-30T03:53:45-08:00 2020-11-30T03:53:45-08:00 type: user
id: 14342567114
name: Jane Doe
login: test@test.com0 127109452066 active 2020-11-30T03:53:45-08:00 type: user
id: 14342567114
name: Jane Doe
login: test@test.comtest-demo name type: user
id: 14342567114
name: Jane Doe
login: test@test.comtype: folder
id: 0
sequence_id: null
etag: null
name: All Filestotal_count: 1
entries: {'type': 'folder', 'id': '0', 'sequence_id': None, 'etag': None, 'name': 'All Files'}0 0 folder
#
box-find-file-folder-by-share-linkReturn the file represented by a shared link.
#
Base Commandbox-find-file-folder-by-share-link
#
InputArgument Name | Description | Required |
---|---|---|
shared_link | Linked used to share the file. | Required |
password | Password used to access the shared link. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | Number | The ID of the item found. |
Box.ShareLink.etag | Number | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.ShareLink.name | String | The name of the item. |
Box.ShareLink.sha1 | String | The SHA1 hash of the item. |
Box.ShareLink.file_version.id | Number | The unique identifier that represent a file version. |
Box.ShareLink.file_version.type | String | Value is always file_version. |
Box.ShareLink.file_version.sha1 | String | The SHA1 hash of this version of the file. |
Box.ShareLink.description | String | The description of the item. |
Box.ShareLink.size | Number | The file size in bytes. |
Box.ShareLink.path_collection.total_count | Number | The number of folders in the list. |
Box.ShareLink.path_collection.entries.id | Number | The ID of the item found. |
Box.ShareLink.path_collection.entries.etag | Number | The entry tag for the item found. |
Box.ShareLink.path_collection.entries.type | String | The type of the item found. |
Box.ShareLink.path_collection.entries.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.ShareLink.path_collection.entries.name | String | The name of the item. |
Box.ShareLink.created_at | Date | The date and time when the item was created on Box. |
Box.ShareLink.modified_at | Date | The date and time when the item was last updated on Box. |
Box.ShareLink.trashed_at | Date | The time at which the item was put in the trash. |
Box.ShareLink.purged_at | Date | The time at which the item is expected to be purged from the trash. |
Box.ShareLink.content_created_at | Date | The date and time at which the item was originally created, which might be before it was uploaded to Box. |
Box.ShareLink.content_modified_at | Date | The date and time at which the item was last updated, which might be before it was uploaded to Box. |
Box.ShareLink.created_by.id | Number | The unique identifier for the user who created the item. |
Box.ShareLink.created_by.type | String | Value is always user. |
Box.ShareLink.created_by.name | String | The display name of the user who created the item. |
Box.ShareLink.created_by.login | String | The primary email address of the user who created the item. |
Box.ShareLink.modified_by.id | Number | The unique identifier for the user who modified the item. |
Box.ShareLink.modified_by.type | String | Value is always user. |
Box.ShareLink.modified_by.name | String | The display name of the user who modified the item. |
Box.ShareLink.modified_by.login | String | The primary email address of the user who modified the item. |
Box.ShareLink.owned_by.id | Number | The unique identifier for the user who owns the item. |
Box.ShareLink.owned_by.type | String | Value is always user. |
Box.ShareLink.owned_by.name | String | The display name of the user who owns the item. |
Box.ShareLink.owned_by.login | String | The primary email address of the user who owns the item. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
Box.ShareLink.parent.id | Number | The ID of the parent for the item found |
Box.ShareLink.parent.etag | Number | The entry tag for the parent of the item found. |
Box.ShareLink.parent.type | String | The type for the parent of the item found. |
Box.ShareLink.parent.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the parent of the item. |
Box.ShareLink.parent.name | String | The name of the parent of the item. |
Box.ShareLink.item_status | String | The status of the parent of the item. |
#
Command Example!box-find-file-folder-by-share-link shared_link="https://app.box.com/s/oyujr5qpxy1nbky394slw7n98v8pnpmy"
#
Context Example#
Human Readable OutputFile/Folder Share Link for
https://app.box.com/s/oyujr5qpxy1nbky394slw7n98v8pnpmy
#
Content Created At Content Modified At Created At Created By Etag File Version Id Item Status Modified At Modified By Name Owned By Path Collection Sequence Id Sha1 Size Type 2020-11-25T05:20:55-08:00 2020-11-25T05:20:55-08:00 2020-11-25T05:20:56-08:00 type: user
id: 14342567114
name: Jane Doe
login: test@test.com2 type: file_version
id: 794731944502
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f745868717302 active 2020-12-01T06:28:21-08:00 type: user
id: 14342567114
name: Jane Doe
login: test@test.com55555.gif type: user
id: 14342567114
name: Jane Doe
login: test@test.comtotal_count: 0
entries:2 1ff8be1766d9e16b0b651f89001e8e7375c9e71f 26891788 file
#
box-get-shared-link-by-fileGets the information for a shared link on a file.
#
Base Commandbox-get-shared-link-by-file
#
InputArgument Name | Description | Required |
---|---|---|
file_id | The unique identifier that represent a file. | Required |
as_user | The user ID for the account used to access the file. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | String | The ID of the item found. |
Box.ShareLink.etag | String | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.entries.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
#
Command Example!box-get-shared-link-by-file file_id="742246263170" as_user="14342567114"
#
Context Example#
Human Readable Output#
Shared link information for the file 742246263170
Access Download Count Download Url Effective Access Effective Permission Is Password Enabled Permissions Preview Count Url open 0 https://app.box.com/shared/static/khro4bw4g6ay68ye70gsnisqsp9c9r23.jpeg
open can_preview false can_preview: true
can_download: false0 https://app.box.com/s/khro4bw4g6ay68ye70gsnisqsp9c9r23
#
box-create-file-share-linkAdds a shared link to a file.
#
Base Commandbox-create-file-share-link
#
InputArgument Name | Description | Required |
---|---|---|
file_id | The unique identifier that represent a file. | Optional |
access | The level of access for the shared link. Possible values are: open, company, collaborators. | Optional |
password | The password required to access the shared link. | Optional |
unshared_at | The timestamp at which this shared link will expire. | Optional |
can_download | If the shared link allows for downloading of files. Possible values are: true, false. | Optional |
as_user | The user who is making the request. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | Number | The ID of the item found. |
Box.ShareLink.etag | Number | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.entries.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
#
Command Example!box-create-file-share-link file_id="742246263170" access="open" as_user="14342567114"
#
Context Example#
Human Readable Output#
File Share Link was created/updated for file_id: 742246263170
Access Download Count Download Url Effective Access Effective Permission Is Password Enabled Permissions Preview Count Url open 0 https://app.box.com/shared/static/khro4bw4g6ay68ye70gsnisqsp9c9r23.jpeg
open can_preview false can_preview: true
can_download: false0 https://app.box.com/s/khro4bw4g6ay68ye70gsnisqsp9c9r23
#
box-update-file-share-linkUpdates a shared link on a file.
#
Base Commandbox-update-file-share-link
#
InputArgument Name | Description | Required |
---|---|---|
access | The level of access for the shared link. Possible values are: open, company, collaborators. | Optional |
password | The password required to access the shared link. | Optional |
unshared_at | The timestamp at which this shared link will expire. | Optional |
can_download | If the shared link allows for downloading of files. Possible values are: true, false. | Optional |
file_id | The unique identifier that represent a file. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | Number | The ID of the item found. |
Box.ShareLink.etag | Number | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.entries.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
#
Command Example!box-update-file-share-link file_id="742246263170" as_user="14342567114"
#
Context Example#
Human Readable Output#
File Share Link was created/updated for file_id: 742246263170
Access Download Count Download Url Effective Access Effective Permission Is Password Enabled Permissions Preview Count Url open 0 https://app.box.com/shared/static/g3xy2he56jd2hfakjv5ptik08de8v15f.jpeg
open can_preview false can_preview: true
can_download: false0 https://app.box.com/s/g3xy2he56jd2hfakjv5ptik08de8v15f
#
box-remove-file-share-linkRemoves a shared link from a file.
#
Base Commandbox-remove-file-share-link
#
InputArgument Name | Description | Required |
---|---|---|
file_id | The unique identifier that represents a file. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | String | The ID of the item found. |
Box.ShareLink.etag | String | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
#
Command Example!box-remove-file-share-link file_id="742246263170" as_user="test@test.com"
#
Context Example#
Human Readable OutputFile Share Link for the file_id 742246263170 was removed.
#
box-get-shared-link-by-folderGets the information for a shared link on a folder.
#
Base Commandbox-get-shared-link-by-folder
#
InputArgument Name | Description | Required |
---|---|---|
folder_id | The unique identifier that represent a folder. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | String | The ID of the item found. |
Box.ShareLink.etag | String | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.entries.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
#
Command Example!box-get-shared-link-by-folder folder_id="125959916474" as_user="14342567114"
#
Context Example#
Human Readable Output#
Shared link information for the folder 125959916474
Etag Id Shared Link Type 0 125959916474 url: https://app.box.com/s/qmfynlq5bpaq5cn7nnbet8vh9nnsswqi
download_url: null
vanity_url: null
vanity_name: null
effective_access: open
effective_permission: can_preview
is_password_enabled: false
unshared_at: null
download_count: 0
preview_count: 0
access: open
permissions: {"can_preview": true, "can_download": false}folder
#
box-create-folder-share-linkAdds a shared link to a folder.
#
Base Commandbox-create-folder-share-link
#
InputArgument Name | Description | Required |
---|---|---|
access | The level of access for the shared link. Possible values are: open, company, collaborators. | Optional |
password | The password required to access the shared link. | Optional |
unshared_at | The timestamp at which this shared link will expire. | Optional |
can_download | If the shared link allows for downloading of folders. Possible values are: true, false. | Optional |
folder_id | The unique identifier that represent a folder. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | String | The ID of the item found. |
Box.ShareLink.etag | String | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.entries.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
#
Command Example!box-create-folder-share-link folder_id="125959916474" as_user="14342567114"
#
Context Example#
Human Readable Output#
Folder Share Link for 125959916474
Etag Id Shared Link Type 0 125959916474 url: https://app.box.com/s/qmfynlq5bpaq5cn7nnbet8vh9nnsswqi
download_url: null
vanity_url: null
vanity_name: null
effective_access: open
effective_permission: can_preview
is_password_enabled: false
unshared_at: null
download_count: 0
preview_count: 0
access: open
permissions: {"can_preview": true, "can_download": false}folder
#
box-update-folder-share-linkUpdates a shared link on a folder.
#
Base Commandbox-update-folder-share-link
#
InputArgument Name | Description | Required |
---|---|---|
folder_id | The unique identifier that represent a folder. | Required |
as_user | The user who is performing the action. | Optional |
access | The level of access for the shared link. Possible values are: open, company, collaborators. | Optional |
password | The password required to access the shared link. | Optional |
unshared_at | The timestamp at which this shared link will expire. | Optional |
can_download | If the shared link allows for downloading of folders. Possible values are: true, false. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | String | The ID of the item found. |
Box.ShareLink.etag | String | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.entries.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
#
Command Example!box-update-folder-share-link folder_id="125959916474" as_user="14342567114" access="open" can_download="false"
#
Context Example#
Human Readable Output#
Folder Share Link for 125959916474
Etag Id Shared Link Type 0 125959916474 url: https://app.box.com/s/uaigc08phyoxnx59nlllecax7mfsrfb1
download_url: null
vanity_url: null
vanity_name: null
effective_access: open
effective_permission: can_preview
is_password_enabled: false
unshared_at: null
download_count: 0
preview_count: 0
access: open
permissions: {"can_preview": true, "can_download": false}folder
#
box-remove-folder-share-linkRemoves a shared link from a folder.
#
Base Commandbox-remove-folder-share-link
#
InputArgument Name | Description | Required |
---|---|---|
folder_id | The unique identifier that represent a folder. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | String | The ID of the item found. |
Box.ShareLink.etag | String | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
#
Command Example!box-remove-folder-share-link folder_id="125959916474" as_user="test@test.com"
#
Context Example#
Human Readable Output#
Folder Share Link for 125959916474 was removed
Etag Id Type 0 125959916474 folder
#
box-get-folderRetrieves details for a folder, including the first 100 entries in the folder.
#
Base Commandbox-get-folder
#
InputArgument Name | Description | Required |
---|---|---|
folder_id | The unique identifier that represent a folder. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.ShareLink.id | Number | The ID of the item found. |
Box.ShareLink.etag | Number | The entry tag for the item found. |
Box.ShareLink.type | String | The type of the item found. |
Box.ShareLink.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.ShareLink.name | String | The name of the item. |
Box.ShareLink.sha1 | String | The SHA1 hash of the item. |
Box.ShareLink.file_version.id | Number | The unique identifier that represent a file version. |
Box.ShareLink.file_version.type | String | Value is always file_version. |
Box.ShareLink.file_version.sha1 | String | The SHA1 hash of this version of the file. |
Box.ShareLink.description | String | The description of the item. |
Box.ShareLink.size | Number | The file size in bytes. |
Box.ShareLink.path_collection.total_count | Number | The number of folders in the list. |
Box.ShareLink.path_collection.entries.id | Number | The ID of the item found. |
Box.ShareLink.path_collection.entries.etag | Number | The entry tag for the item found. |
Box.ShareLink.path_collection.entries.type | String | The type of the item found. |
Box.ShareLink.path_collection.entries.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.ShareLink.path_collection.entries.name | String | The name of the item. |
Box.ShareLink.created_at | Date | The date and time when the item was created on Box. |
Box.ShareLink.modified_at | Date | The date and time when the item was last updated on Box. |
Box.ShareLink.trashed_at | Date | The time at which the item was put in the trash. |
Box.ShareLink.purged_at | Date | The time at which the item is expected to be purged from the trash. |
Box.ShareLink.content_created_at | Date | The date and time at which the item was originally created, which might be before it was uploaded to Box. |
Box.ShareLink.content_modified_at | Date | The date and time at which the item was last updated, which might be before it was uploaded to Box. |
Box.ShareLink.created_by.id | Number | The unique identifier for the user who created the item. |
Box.ShareLink.created_by.type | String | Value is always user. |
Box.ShareLink.created_by.name | String | The display name of the user who created the item. |
Box.ShareLink.created_by.login | String | The primary email address of the user who created the item. |
Box.ShareLink.modified_by.id | Number | The unique identifier for the user who modified the item. |
Box.ShareLink.modified_by.type | String | Value is always user. |
Box.ShareLink.modified_by.name | String | The display name of the user who modified the item. |
Box.ShareLink.modified_by.login | String | The primary email address of the user who modified the item. |
Box.ShareLink.owned_by.id | Number | The unique identifier for the user who owns the item. |
Box.ShareLink.owned_by.type | String | Value is always user. |
Box.ShareLink.owned_by.name | String | The display name of the user who owns the item. |
Box.ShareLink.owned_by.login | String | The primary email address of the user who owns the item. |
Box.ShareLink.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.ShareLink.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.ShareLink.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.ShareLink.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.ShareLink.shared_link.access | String | The access level for the shared link. |
Box.ShareLink.shared_link.effective_access | String | The effective access level for the shared link. |
Box.ShareLink.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.ShareLink.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.ShareLink.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.ShareLink.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.ShareLink.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.ShareLink.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.ShareLink.shared_link.preview_count | Number | The number of times the item has been previewed. |
Box.ShareLink.parent.id | Number | The ID of the parent for the item found |
Box.ShareLink.parent.etag | Number | The entry tag for the parent of the item found. |
Box.ShareLink.parent.type | String | The type for the parent of the item found. |
Box.ShareLink.parent.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the parent of the item. |
Box.ShareLink.parent.name | String | The name of the parent of the item. |
Box.ShareLink.item_status | String | The status of the parent of the item. |
#
Command Example!box-get-folder folder_id="0" as_user="14342567114"
#
Context Example#
Human Readable Output#
Folder overview for 0
Created By Id Item Status Modified By Name Owned By Path Collection Size Type type: user
id:
name:
login:0 active type: user
id: 14342567114
name: Jane Doe
login: test@test.comAll Files type: user
id: 14342567114
name: Jane Doe
login: test@test.comtotal_count: 0
entries:212311360 folder #
File contents for the folder 0
Etag Id Name Sequence Id Type 0 125959916474 My Box Notes 0 folder 0 128036492321 Sample Folder for Docs 0 folder 0 126452434994 Sample Testing Folder 0 folder 0 127912817927 Sample Testing Folder 2 0 folder 0 126469445717 Sample Testing Folder test 0 folder 0 127304720432 Sample Testing Folder test1 0 folder 0 127109452066 test-demo name 0 folder 2 745868717302 55555.gif 2 file 0 752998071936 customers.jpg 0 file 0 745851995250 image.gif 0 file 0 745854929853 image1.gif 0 file 0 745857164822 image2.gif 0 file 0 745859107884 image3.gif 0 file 0 745870218112 image4.gif 0 file 0 745873525854 image6_please_work.gif 0 file 2 743439873060 new-devs-touching-the-build.gif 2 file 5 745898898314 testing event1234.gif 5 file 3 753421883491 vandijk5.gif 3 file
#
box-list-folder-itemsRetrieves a page of items in a folder.
#
Base Commandbox-list-folder-items
#
InputArgument Name | Description | Required |
---|---|---|
folder_id | The unique identifier that represent a folder. | Required |
as_user | The user who is performing the action. | Optional |
limit | The maximum number of items to return per page. Default is "100". | Optional |
offset | The offset of the item at which to begin the response. Default is "0". | Optional |
sort | The field the results should be sorted by. Possible values are: id, name, date, size. Default is name. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.Folder.id | Number | The ID of the folder. |
Box.Folder.etag | Number | The entity tag of the folder. |
Box.Folder.type | String | Value is always `folder`. |
Box.Folder.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Folder.name | String | The name of the folder. |
Box.Folder.sha1 | String | The SHA1 has of the folder. |
Box.Folder.file_version.id | Number | The unique identifier that represent a file version. |
Box.Folder.file_version.type | String | Value is always file_version. |
Box.Folder.file_version.sha1 | String | The SHA1 hash of this version of the file. |
#
Command Example!box-list-folder-items folder_id="0" as_user="test@test.com"
#
Context Example#
Human Readable Output#
Folder overview for 0
Created By Id Item Status Modified By Name Owned By Path Collection Size Type type: user
id:
name:
login:0 active type: user
id: 14342567114
name: Jane Doe
login: test@test.comAll Files type: user
id: 14342567114
name: Jane Doe
login: test@test.comtotal_count: 0
entries:212311360 folder #
File contents for the folder 0
Etag Id Name Sequence Id Type 0 125959916474 My Box Notes 0 folder 0 128036492321 Sample Folder for Docs 0 folder 0 126452434994 Sample Testing Folder 0 folder 0 127912817927 Sample Testing Folder 2 0 folder 0 126469445717 Sample Testing Folder test 0 folder 0 127304720432 Sample Testing Folder test1 0 folder 0 127109452066 test-demo name 0 folder 2 745868717302 55555.gif 2 file 0 752998071936 customers.jpg 0 file 0 745851995250 image.gif 0 file 0 745854929853 image1.gif 0 file 0 745857164822 image2.gif 0 file 0 745859107884 image3.gif 0 file 0 745870218112 image4.gif 0 file 0 745873525854 image6_please_work.gif 0 file 2 743439873060 new-devs-touching-the-build.gif 2 file 5 745898898314 testing event1234.gif 5 file 3 753421883491 vandijk5.gif 3 file
#
box-folder-createCreates a new empty folder within the specified parent folder.
#
Base Commandbox-folder-create
#
InputArgument Name | Description | Required |
---|---|---|
name | The name for the new folder. | Required |
parent_id | The parent folder to create the new folder within. Default is 0. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.Folder.id | Number | The ID of the folder created. |
Box.Folder.etag | Number | The entry tag for the folder created. |
Box.Folder.type | String | The type of folder. |
Box.Folder.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the folder. |
Box.Folder.name | String | The name of the folder. |
Box.Folder.sha1 | String | The SHA1 hash of the folder. |
Box.Folder.file_version.id | Number | The unique identifier that represents a file version. |
Box.Folder.file_version.type | String | Value is always file_version. |
Box.Folder.file_version.sha1 | String | The SHA1 hash of this version of the file. |
Box.Folder.description | String | The description of the item. |
Box.Folder.size | Number | The folder size in bytes. |
Box.Folder.path_collection.total_count | Number | The number of folders in the list. |
Box.Folder.path_collection.entries.id | Number | The ID of the item found. |
Box.Folder.path_collection.entries.etag | Number | The entry tag for the item found. |
Box.Folder.path_collection.entries.type | String | The type of the item found. |
Box.Folder.path_collection.entries.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Folder.path_collection.entries.name | String | The name of the item. |
Box.Folder.created_at | Date | The date and time when the item was created on Box. |
Box.Folder.modified_at | Date | The date and time when the item was last updated on Box. |
Box.Folder.trashed_at | Date | The time at which the item was put in the trash. |
Box.Folder.purged_at | Date | The time at which the item is expected to be purged from the trash. |
Box.Folder.content_created_at | Date | The date and time at which the item was originally created, which might be before it was uploaded to Box. |
Box.Folder.content_modified_at | Date | The date and time at which the item was last updated, which might be before it was uploaded to Box. |
Box.Folder.created_by.id | Number | The unique identifier for the user who created the item. |
Box.Folder.created_by.type | String | Value is always user. |
Box.Folder.created_by.name | String | The display name of the user who created the item. |
Box.Folder.created_by.login | String | The primary email address of the user who created the item. |
Box.Folder.modified_by.id | Number | The unique identifier for the user who modified the item. |
Box.Folder.modified_by.type | String | Value is always user. |
Box.Folder.modified_by.name | String | The display name of the user who modified the item. |
Box.Folder.modified_by.login | String | The primary email address of the user who modified the item. |
Box.Folder.owned_by.id | Number | The unique identifier for the user who owns the item. |
Box.Folder.owned_by.type | String | Value is always user. |
Box.Folder.owned_by.name | String | The display name of the user who owns the item. |
Box.Folder.owned_by.login | String | The primary email address of the user who owns the item. |
Box.Folder.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.Folder.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.Folder.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.Folder.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.Folder.shared_link.access | String | The access level for the shared link. |
Box.Folder.shared_link.effective_access | String | The effective access level for the shared link. |
Box.Folder.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.Folder.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.Folder.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.Folder.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.Folder.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.Folder.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.Folder.shared_link.preview_count | Number | The number of times the item has been previewed. |
Box.Folder.parent.id | Number | The ID of the parent for the item found |
Box.Folder.parent.etag | Number | The entry tag for the parent of the item found. |
Box.Folder.parent.type | String | The type for the parent of the item found. |
Box.Folder.parent.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the parent of the item. |
Box.Folder.parent.name | String | The name of the parent of the item. |
Box.Folder.item_status | String | The status of the parent of the item. |
#
Command Example!box-folder-create name="Sample Folder for Docs" parent_id="0" as_user="14342567114"
#
Context Example#
Human Readable OutputFolder named Sample Folder for Docs, was successfully created.
#
box-file-deleteDeletes a file, either permanently or by moving it to the trash.
#
Base Commandbox-file-delete
#
InputArgument Name | Description | Required |
---|---|---|
file_id | The unique identifier that represent a file. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputThere is no context output for this command.
#
Command Example!box-file-delete file_id="751526132294" as_user="14342567114"
#
Context Example#
Human Readable OutputThe file 751526132294 was successfully deleted.
#
box-list-usersReturns a list of all users for the Enterprise along with their user_id, public_name, and login.
#
Base Commandbox-list-users
#
InputArgument Name | Description | Required |
---|---|---|
fields | Attributes to include in the response. Possible values are: id, type, name. | Optional |
filter_term | Limits the results to only users who's name or login start with the search term. | Optional |
limit | The maximum number of items to return per page. Default is "100". | Optional |
offset | The offset of the item at which to begin the response. Default is "0". | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.User.id | Number | The unique identifier for this user. |
Box.User.type | String | Value is always user. |
Box.User.name | String | The display name of this user. |
Box.User.login | String | The primary email address of this user. |
Box.User.created_at | Date | When the user object was created. |
Box.User.modified_at | Date | When the user object was last modified. |
Box.User.language | String | The language of the user, formatted in a modified version of the ISO 639-1 format. |
Box.User.timezone | String | The user's timezone. |
Box.User.space_amount | Number | The user's total available space amount in bytes. |
Box.User.space_used | Number | The amount of space in use by the user. |
Box.User.max_upload_size | Number | The maximum individual file size in bytes the user can have. |
Box.User.status | String | The user's account status. |
Box.User.job_title | String | The user's job title. |
Box.User.phone | Number | The users phone number. |
Box.User.address | String | The user's address. |
Box.User.avatar_url | String | URL of the user's avatar image |
Box.User.notification_email.email | String | The email address to send the notifications to. |
Box.User.notification_email.is_confirmed | Boolean | Specifies if this email address has been confirmed. |
#
Command Example!box-list-users fields=name filter_term="Andrew"
#
Context Example#
Human Readable Output#
The following users were found
Id Name Type 14342567114 Jane Doe user
#
box-upload-fileUploads a file to the given folder.
#
Base Commandbox-upload-file
#
InputArgument Name | Description | Required |
---|---|---|
entry_id | The entry ID of the file to upload. | Required |
as_user | The ID of the user who is performing the action. | Optional |
file_name | The name of the file. | Optional |
folder_id | The ID of the folder the file is being uploaded to. Default is 0/root. | Required |
#
Context OutputPath | Type | Description |
---|---|---|
Box.File.id | Number | The ID of the item found. |
Box.File.etag | Number | The entry tag for the item found. |
Box.File.type | String | The type of the item found. |
Box.File.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.File.name | String | The name of the item. |
Box.File.sha1 | String | The SHA1 hash of the item. |
Box.File.file_version.id | Number | The unique identifier that represent a file version. |
Box.File.file_version.type | String | Value is always file_version. |
Box.File.file_version.sha1 | String | The SHA1 hash of this version of the file. |
Box.File.description | String | The description of the item. |
Box.File.size | Number | The file size in bytes. |
Box.File.path_collection.total_count | Number | The number of folders in the list. |
Box.File.path_collection.entries.id | Number | The ID of the item found. |
Box.File.path_collection.entries.etag | Number | The entry tag for the item found. |
Box.File.path_collection.entries.type | String | The type of the item found. |
Box.File.path_collection.entries.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.File.path_collection.entries.name | String | The name of the item. |
Box.File.created_at | Date | The date and time when the item was created on Box. |
Box.File.modified_at | Date | The date and time when the item was last updated on Box. |
Box.File.trashed_at | Date | The time at which the item was put in the trash. |
Box.File.purged_at | Date | The time at which the item is expected to be purged from the trash. |
Box.File.content_created_at | Date | The date and time at which the item was originally created, which might be before it was uploaded to Box. |
Box.File.content_modified_at | Date | The date and time at which the item was last updated, which might be before it was uploaded to Box. |
Box.File.created_by.id | Number | The unique identifier for the user who created the item. |
Box.File.created_by.type | String | Value is always user. |
Box.File.created_by.name | String | The display name of the user who created the item. |
Box.File.created_by.login | String | The primary email address of the user who created the item. |
Box.File.modified_by.id | Number | The unique identifier for the user who modified the item. |
Box.File.modified_by.type | String | Value is always user. |
Box.File.modified_by.name | String | The display name of the user who modified the item. |
Box.File.modified_by.login | String | The primary email address of the user who modified the item. |
Box.File.owned_by.id | Number | The unique identifier for the user who owns the item. |
Box.File.owned_by.type | String | Value is always user. |
Box.File.owned_by.name | String | The display name of the user who owns the item. |
Box.File.owned_by.login | String | The primary email address of the user who owns the item. |
Box.File.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.File.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.File.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.File.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.File.shared_link.access | String | The access level for the shared link. |
Box.File.shared_link.effective_access | String | The effective access level for the shared link. |
Box.File.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.File.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.File.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.File.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.File.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.File.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.File.shared_link.preview_count | Number | The number of times the item has been previewed. |
Box.File.parent.id | Number | The ID of the parent for the item found |
Box.File.parent.etag | Number | The entry tag for the parent of the item found. |
Box.File.parent.type | String | The type for the parent of the item found. |
Box.File.parent.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the parent of the item. |
Box.File.parent.name | String | The name of the parent of the item. |
Box.File.item_status | String | The status of the parent of the item. |
#
Command Example!box-upload-file entry_id="364@c9316be6-93dc-440a-8c68-c68912590052" folder_id="0" file_name="changelog.json" as_user="14342567114"
#
Context Example#
Human Readable OutputFile was successfully uploaded
#
box-trashed-items-listRetrieves the files and folders that have been moved to the trash.
#
Base Commandbox-trashed-items-list
#
InputArgument Name | Description | Required |
---|---|---|
as_user | The user performing the action. | Optional |
limit | The maximum number of items to return per page. Default is "100". | Optional |
offset | The offset of the item at which to begin the response. Default is "0". | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.Trash.id | Number | The ID of the item found. |
Box.Trash.etag | Number | The entry tag for the item found. |
Box.Trash.type | String | The type of the item found. |
Box.Trash.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Trash.name | String | The name of the item. |
Box.Trash.sha1 | String | The SHA1 hash of the item. |
Box.Trash.file_version.id | Number | The unique identifier that represent a file version. |
Box.Trash.file_version.type | String | Value is always file_version. |
Box.Trash.file_version.sha1 | String | The SHA1 hash of this version of the file. |
#
Command Example!box-trashed-items-list as_user="14342567114"
#
Context Example#
Human Readable Output#
Trashed items were found
Etag File Version Id Name Sequence Id Sha1 Type 11 type: file_version
id: 801011020694
sha1: aa58d9692d58f5d9316d7cf1950d19a0b01bc204751526132294 list.json 11 aa58d9692d58f5d9316d7cf1950d19a0b01bc204 file
#
box-trashed-item-restoreRestores a file or folder that has been moved to the trash.
#
Base Commandbox-trashed-item-restore
#
InputArgument Name | Description | Required |
---|---|---|
item_id | The unique identifier that represents the file or folder. | Required |
type | Type of the object to restore. Possible values are: file, folder. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputPath | Type | Description |
---|---|---|
Box.Item.id | Number | The ID of the item found. |
Box.Item.etag | Number | The entry tag for the item found. |
Box.Item.type | String | The type of the item found. |
Box.Item.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Item.name | String | The name of the item. |
Box.Item.sha1 | String | The SHA1 hash of the item. |
Box.Item.file_version.id | Number | The unique identifier that represent a file version. |
Box.Item.file_version.type | String | Value is always file_version. |
Box.Item.file_version.sha1 | String | The SHA1 hash of this version of the file. |
Box.Item.description | String | The description of the item. |
Box.Item.size | Number | The file size in bytes. |
Box.Item.path_collection.total_count | Number | The number of folders in the list. |
Box.Item.path_collection.entries.id | Number | The ID of the item found. |
Box.Item.path_collection.entries.etag | Number | The entry tag for the item found. |
Box.Item.path_collection.entries.type | String | The type of the item found. |
Box.Item.path_collection.entries.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the item. |
Box.Item.path_collection.entries.name | String | The name of the item. |
Box.Item.created_at | Date | The date and time when the item was created on Box. |
Box.Item.modified_at | Date | The date and time when the item was last updated on Box. |
Box.Item.trashed_at | Date | The time at which the item was put in the trash. |
Box.Item.purged_at | Date | The time at which the item is expected to be purged from the trash. |
Box.Item.content_created_at | Date | The date and time at which the item was originally created, which might be before it was uploaded to Box. |
Box.Item.content_modified_at | Date | The date and time at which the item was last updated, which might be before it was uploaded to Box. |
Box.Item.created_by.id | Number | The unique identifier for the user who created the item. |
Box.Item.created_by.type | String | Value is always user. |
Box.Item.created_by.name | String | The display name of the user who created the item. |
Box.Item.created_by.login | String | The primary email address of the user who created the item. |
Box.Item.modified_by.id | Number | The unique identifier for the user who modified the item. |
Box.Item.modified_by.type | String | Value is always user. |
Box.Item.modified_by.name | String | The display name of the user who modified the item. |
Box.Item.modified_by.login | String | The primary email address of the user who modified the item. |
Box.Item.owned_by.id | Number | The unique identifier for the user who owns the item. |
Box.Item.owned_by.type | String | Value is always user. |
Box.Item.owned_by.name | String | The display name of the user who owns the item. |
Box.Item.owned_by.login | String | The primary email address of the user who owns the item. |
Box.Item.shared_link.url | String | The URL that can be used to access the item on Box. |
Box.Item.shared_link.download_url | String | The URL that can be used to download the item from Box. |
Box.Item.shared_link.vanity_url | String | The "Custom URL" that can also be used to preview the item on Box. |
Box.Item.shared_link.vanity_name | String | The custom name of a shared link, as used in the vanity_url field. |
Box.Item.shared_link.access | String | The access level for the shared link. |
Box.Item.shared_link.effective_access | String | The effective access level for the shared link. |
Box.Item.shared_link.effective_permission | String | The effective permissions for this shared link. |
Box.Item.shared_link.unshared_at | Date | The date and time when the link will be unshared. |
Box.Item.shared_link.is_password_enabled | Boolean | Defines if the shared link requires a password to access the item. |
Box.Item.shared_link.permissions.can_download | Boolean | Defines if the shared link allows for the item to be downloaded. |
Box.Item.shared_link.permissions.can_preview | Boolean | Defines if the shared link allows for the item to be previewed. |
Box.Item.shared_link.download_count | Number | The number of times the item has been downloaded. |
Box.Item.shared_link.preview_count | Number | The number of times the item has been previewed. |
Box.Item.parent.id | Number | The ID of the parent for the item found |
Box.Item.parent.etag | Number | The entry tag for the parent of the item found. |
Box.Item.parent.type | String | The type for the parent of the item found. |
Box.Item.parent.sequence_id | Number | The numeric identifier that represents the most recent user event that has been applied to the parent of the item. |
Box.Item.parent.name | String | The name of the parent of the item. |
Box.Item.item_status | String | The status of the parent of the item. |
#
Command Example!box-trashed-item-restore item_id="751526132294" type="file" as_user="14342567114"
#
Context Example#
Human Readable OutputItem with the ID 751526132294 was restored.
#
box-trashed-item-delete-permanentlyPermanently deletes a file or folder that is in the trash. This action cannot be undone.
#
Base Commandbox-trashed-item-delete-permanently
#
InputArgument Name | Description | Required |
---|---|---|
item_id | The unique identifier that represents the file or folder. | Required |
type | The type of the item to delete. Possible values are: file, folder. | Required |
as_user | The user who is performing the action. | Optional |
#
Context OutputThere is no context output for this command.