Skip to main content

Box v2

Manage Box users This integration was integrated and tested with API version 2.0 of Box v2

Configure the Box Application to Interface with XSOAR#

  1. Navigate to the developer console for Box.
  2. Click Create a New App.
  3. Select Custom App and when prompted, select Server Authentication (with JWT)
  4. Enter your desired App Name.
  5. In the Configuration menu under Application Access, select Enterprise.
  6. Under the Advanced Features option, enable both Perform Actions as Users and Generate User Access Tokens.
  7. In the Add and Manage Public Keys section, click Generate a Public/Private Keypair and follow the prompts.
  8. Click Save Changes in the upper right-hand corner.
  9. 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 XSOAR#

  1. Navigate to Settings > Integrations > Servers & Services.

  2. Search for Box v2.

  3. Click Add instance to create and configure a new integration instance.

    ParameterDescriptionRequired
    insecureTrust any certificate (not secure)False
    credentials_jsonCredentials JSONTrue
    as_userAs User for Fetching IncidentsFalse
    event_typeFalse
    default_userDefault UserFalse
    search_user_idAuto-detect user IDs based on their email address.False
    incidentTypeIncident typeFalse
    isFetchFetch incidentsFalse
    first_fetchFirst fetch timestamp (<number> <time unit>, e.g., 12 hours, 7 days)False
    max_fetchFalse
  4. 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.

Commands#

You 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-content#


Searches for files, folders, web links, and shared files across the users content or across the entire enterprise.

Base Command#

box-search-content

Input#

Argument NameDescriptionRequired
typeLimits 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_idsA comma-separated lists of folder IDs that limits the search results to items within the given list of folders.Optional
item_nameQuery for an item by name.Optional
item_descriptionThe description of the item to search for.Optional
commentsThe comments of the item to search for.Optional
tagThe tag of the item to search for.Optional
created_rangeA 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_extensionsLimits the search results to any files that match any of the provided file extensions.Optional
limitThe maximum number of items to return as part of a page of results. Default is "100".Optional
offsetThe offset of the item at which to begin the response. Default is "0".Optional
owner_uidsA 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_contentWhether the search should look in the trash for items.Optional
updated_at_rangeLimits the search results to any items updated within a given date range.Optional
queryThe string to search for.Optional

Context Output#

PathTypeDescription
Box.Query.idNumberThe ID of the item found.
Box.Query.etagNumberThe entry tag for the item found.
Box.Query.typeStringThe type of the item found.
Box.Query.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Query.nameStringThe name of the item.
Box.Query.sha1StringThe SHA1 hash of the item.
Box.Query.file_version.idNumberThe unique identifier that represent a file version.
Box.Query.file_version.typeStringValue is always file_version.
Box.Query.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.Query.descriptionStringThe description of the item.
Box.Query.sizeNumberThe file size in bytes.
Box.Query.path_collection.total_countNumberThe number of folders in the list.
Box.Query.path_collection.entries.idNumberThe ID of the item found.
Box.Query.path_collection.entries.etagNumberThe entry tag for the item found.
Box.Query.path_collection.entries.typeStringThe type of the item found.
Box.Query.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Query.path_collection.entries.nameStringThe name of the item.
Box.Query.created_atDateThe date and time when the item was created on Box.
Box.Query.modified_atDateThe date and time when the item was last updated on Box.
Box.Query.trashed_atDateThe time at which the item was put in the trash.
Box.Query.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.Query.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.Query.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.Query.created_by.idNumberThe unique identifier for the user who created the item.
Box.Query.created_by.typeStringValue is always user.
Box.Query.created_by.nameStringThe display name of the user who created the item.
Box.Query.created_by.loginStringThe primary email address of the user who created the item.
Box.Query.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.Query.modified_by.typeStringValue is always user.
Box.Query.modified_by.nameStringThe display name of the user who modified the item.
Box.Query.modified_by.loginStringThe primary email address of the user who modified the item.
Box.Query.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.Query.owned_by.typeStringValue is always user.
Box.Query.owned_by.nameStringThe display name of the user who owns the item.
Box.Query.owned_by.loginStringThe primary email address of the user who owns the item.
Box.Query.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.Query.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.Query.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.Query.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.Query.entries.shared_link.accessStringThe access level for the shared link.
Box.Query.shared_link.effective_accessStringThe effective access level for the shared link.
Box.Query.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.Query.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.Query.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.Query.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.Query.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.Query.entries.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.Query.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.Query.parent.idNumberThe ID of the parent for the item found
Box.Query.parent.etagNumberThe entry tag for the parent of the item found.
Box.Query.parent.typeStringThe type for the parent of the item found.
Box.Query.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.Query.parent.nameStringThe name of the parent of the item.
Box.Query.item_statusStringThe status of the parent of the item.

Command Example#

!box-search-content item_name="test" limit="1"

Context Example#

{
"Box": {
"Query": {
"content_created_at": "2020-11-30T03:53:45-08:00",
"content_modified_at": "2020-11-30T03:53:45-08:00",
"created_at": "2020-11-30T03:53:45-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"folder_upload_email": null,
"id": "127109452066",
"item_status": "active",
"modified_at": "2020-11-30T03:53:45-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "test-demo name",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"shared_link": null,
"size": 0,
"trashed_at": null,
"type": "folder"
}
}
}

Human Readable Output#

Search results#

Content Created AtContent Modified AtCreated AtCreated ByEtagIdItem StatusModified AtModified ByNameOwned ByParentPath CollectionSequence IdSizeType
2020-11-30T03:53:45-08:002020-11-30T03:53:45-08:002020-11-30T03:53:45-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
0127109452066active2020-11-30T03:53:45-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
test-demo nametype: user
id: 14342567114
name: Jane Doe
login: test@test.com
type: folder
id: 0
sequence_id: null
etag: null
name: All Files
total_count: 1
entries: {'type': 'folder', 'id': '0', 'sequence_id': None, 'etag': None, 'name': 'All Files'}
00folder

box-find-file-folder-by-share-link#


Return the file represented by a shared link.

Base Command#

box-find-file-folder-by-share-link

Input#

Argument NameDescriptionRequired
shared_linkLinked used to share the file.Required
passwordPassword used to access the shared link.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idNumberThe ID of the item found.
Box.ShareLink.etagNumberThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.ShareLink.nameStringThe name of the item.
Box.ShareLink.sha1StringThe SHA1 hash of the item.
Box.ShareLink.file_version.idNumberThe unique identifier that represent a file version.
Box.ShareLink.file_version.typeStringValue is always file_version.
Box.ShareLink.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.ShareLink.descriptionStringThe description of the item.
Box.ShareLink.sizeNumberThe file size in bytes.
Box.ShareLink.path_collection.total_countNumberThe number of folders in the list.
Box.ShareLink.path_collection.entries.idNumberThe ID of the item found.
Box.ShareLink.path_collection.entries.etagNumberThe entry tag for the item found.
Box.ShareLink.path_collection.entries.typeStringThe type of the item found.
Box.ShareLink.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.ShareLink.path_collection.entries.nameStringThe name of the item.
Box.ShareLink.created_atDateThe date and time when the item was created on Box.
Box.ShareLink.modified_atDateThe date and time when the item was last updated on Box.
Box.ShareLink.trashed_atDateThe time at which the item was put in the trash.
Box.ShareLink.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.ShareLink.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.ShareLink.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.ShareLink.created_by.idNumberThe unique identifier for the user who created the item.
Box.ShareLink.created_by.typeStringValue is always user.
Box.ShareLink.created_by.nameStringThe display name of the user who created the item.
Box.ShareLink.created_by.loginStringThe primary email address of the user who created the item.
Box.ShareLink.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.ShareLink.modified_by.typeStringValue is always user.
Box.ShareLink.modified_by.nameStringThe display name of the user who modified the item.
Box.ShareLink.modified_by.loginStringThe primary email address of the user who modified the item.
Box.ShareLink.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.ShareLink.owned_by.typeStringValue is always user.
Box.ShareLink.owned_by.nameStringThe display name of the user who owns the item.
Box.ShareLink.owned_by.loginStringThe primary email address of the user who owns the item.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.ShareLink.parent.idNumberThe ID of the parent for the item found
Box.ShareLink.parent.etagNumberThe entry tag for the parent of the item found.
Box.ShareLink.parent.typeStringThe type for the parent of the item found.
Box.ShareLink.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.ShareLink.parent.nameStringThe name of the parent of the item.
Box.ShareLink.item_statusStringThe 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#

{
"Box": {
"ShareLink": {
"content_created_at": "2020-11-25T05:20:55-08:00",
"content_modified_at": "2020-11-25T05:20:55-08:00",
"created_at": "2020-11-25T05:20:56-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "2",
"file_version": {
"id": "794731944502",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745868717302",
"item_status": "active",
"modified_at": "2020-12-01T06:28:21-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "55555.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": null,
"path_collection": {
"entries": [],
"total_count": 0
},
"purged_at": null,
"sequence_id": "2",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"trashed_at": null,
"type": "file"
}
}
}

Human Readable Output#

File/Folder Share Link for https://app.box.com/s/oyujr5qpxy1nbky394slw7n98v8pnpmy#

Content Created AtContent Modified AtCreated AtCreated ByEtagFile VersionIdItem StatusModified AtModified ByNameOwned ByPath CollectionSequence IdSha1SizeType
2020-11-25T05:20:55-08:002020-11-25T05:20:55-08:002020-11-25T05:20:56-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
2type: file_version
id: 794731944502
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
745868717302active2020-12-01T06:28:21-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
55555.giftype: user
id: 14342567114
name: Jane Doe
login: test@test.com
total_count: 0
entries:
21ff8be1766d9e16b0b651f89001e8e7375c9e71f26891788file

box-get-shared-link-by-file#


Gets the information for a shared link on a file.

Base Command#

box-get-shared-link-by-file

Input#

Argument NameDescriptionRequired
file_idThe unique identifier that represent a file.Required
as_userThe user ID for the account used to access the file.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idStringThe ID of the item found.
Box.ShareLink.etagStringThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.entries.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe number of times the item has been previewed.

Command Example#

!box-get-shared-link-by-file file_id="742246263170" as_user="14342567114"

Context Example#

{
"Box": {
"ShareLink": {
"etag": "17",
"id": "742246263170",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/khro4bw4g6ay68ye70gsnisqsp9c9r23.jpeg",
"effective_access": "open",
"effective_permission": "can_preview",
"is_password_enabled": false,
"permissions": {
"can_download": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": null,
"url": "https://app.box.com/s/khro4bw4g6ay68ye70gsnisqsp9c9r23",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
}
}

Human Readable Output#

Shared link information for the file 742246263170#

AccessDownload CountDownload UrlEffective AccessEffective PermissionIs Password EnabledPermissionsPreview CountUrl
open0https://app.box.com/shared/static/khro4bw4g6ay68ye70gsnisqsp9c9r23.jpegopencan_previewfalsecan_preview: true
can_download: false
0https://app.box.com/s/khro4bw4g6ay68ye70gsnisqsp9c9r23

box-create-file-share-link#


Adds a shared link to a file.

Base Command#

box-create-file-share-link

Input#

Argument NameDescriptionRequired
file_idThe unique identifier that represent a file.Optional
accessThe level of access for the shared link. Possible values are: open, company, collaborators.Optional
passwordThe password required to access the shared link.Optional
unshared_atThe timestamp at which this shared link will expire.Optional
can_downloadIf the shared link allows for downloading of files. Possible values are: true, false.Optional
as_userThe user who is making the request.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idNumberThe ID of the item found.
Box.ShareLink.etagNumberThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.entries.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe 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#

{
"Box": {
"ShareLink": {
"etag": "17",
"id": "742246263170",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/khro4bw4g6ay68ye70gsnisqsp9c9r23.jpeg",
"effective_access": "open",
"effective_permission": "can_preview",
"is_password_enabled": false,
"permissions": {
"can_download": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": null,
"url": "https://app.box.com/s/khro4bw4g6ay68ye70gsnisqsp9c9r23",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
}
}

Human Readable Output#

File Share Link was created/updated for file_id: 742246263170#

AccessDownload CountDownload UrlEffective AccessEffective PermissionIs Password EnabledPermissionsPreview CountUrl
open0https://app.box.com/shared/static/khro4bw4g6ay68ye70gsnisqsp9c9r23.jpegopencan_previewfalsecan_preview: true
can_download: false
0https://app.box.com/s/khro4bw4g6ay68ye70gsnisqsp9c9r23

box-update-file-share-link#


Updates a shared link on a file.

Base Command#

box-update-file-share-link

Input#

Argument NameDescriptionRequired
accessThe level of access for the shared link. Possible values are: open, company, collaborators.Optional
passwordThe password required to access the shared link.Optional
unshared_atThe timestamp at which this shared link will expire.Optional
can_downloadIf the shared link allows for downloading of files. Possible values are: true, false.Optional
file_idThe unique identifier that represent a file.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idNumberThe ID of the item found.
Box.ShareLink.etagNumberThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.entries.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe number of times the item has been previewed.

Command Example#

!box-update-file-share-link file_id="742246263170" as_user="14342567114"

Context Example#

{
"Box": {
"ShareLink": {
"etag": "19",
"id": "742246263170",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": "https://app.box.com/shared/static/g3xy2he56jd2hfakjv5ptik08de8v15f.jpeg",
"effective_access": "open",
"effective_permission": "can_preview",
"is_password_enabled": false,
"permissions": {
"can_download": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": null,
"url": "https://app.box.com/s/g3xy2he56jd2hfakjv5ptik08de8v15f",
"vanity_name": null,
"vanity_url": null
},
"type": "file"
}
}
}

Human Readable Output#

File Share Link was created/updated for file_id: 742246263170#

AccessDownload CountDownload UrlEffective AccessEffective PermissionIs Password EnabledPermissionsPreview CountUrl
open0https://app.box.com/shared/static/g3xy2he56jd2hfakjv5ptik08de8v15f.jpegopencan_previewfalsecan_preview: true
can_download: false
0https://app.box.com/s/g3xy2he56jd2hfakjv5ptik08de8v15f

box-remove-file-share-link#


Removes a shared link from a file.

Base Command#

box-remove-file-share-link

Input#

Argument NameDescriptionRequired
file_idThe unique identifier that represents a file.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idStringThe ID of the item found.
Box.ShareLink.etagStringThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.

Command Example#

!box-remove-file-share-link file_id="742246263170" as_user="test@test.com"

Context Example#

{
"Box": {
"ShareLink": {
"etag": "18",
"id": "742246263170",
"shared_link": null,
"type": "file"
}
}
}

Human Readable Output#

File Share Link for the file_id 742246263170 was removed.

box-get-shared-link-by-folder#


Gets the information for a shared link on a folder.

Base Command#

box-get-shared-link-by-folder

Input#

Argument NameDescriptionRequired
folder_idThe unique identifier that represent a folder.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idStringThe ID of the item found.
Box.ShareLink.etagStringThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.entries.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe number of times the item has been previewed.

Command Example#

!box-get-shared-link-by-folder folder_id="125959916474" as_user="14342567114"

Context Example#

{
"Box": {
"FolderShareLink": {
"etag": "0",
"id": "125959916474",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": null,
"effective_access": "open",
"effective_permission": "can_preview",
"is_password_enabled": false,
"permissions": {
"can_download": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": null,
"url": "https://app.box.com/s/qmfynlq5bpaq5cn7nnbet8vh9nnsswqi",
"vanity_name": null,
"vanity_url": null
},
"type": "folder"
}
}
}

Human Readable Output#

Shared link information for the folder 125959916474#

EtagIdShared LinkType
0125959916474url: 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-link#


Adds a shared link to a folder.

Base Command#

box-create-folder-share-link

Input#

Argument NameDescriptionRequired
accessThe level of access for the shared link. Possible values are: open, company, collaborators.Optional
passwordThe password required to access the shared link.Optional
unshared_atThe timestamp at which this shared link will expire.Optional
can_downloadIf the shared link allows for downloading of folders. Possible values are: true, false.Optional
folder_idThe unique identifier that represent a folder.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idStringThe ID of the item found.
Box.ShareLink.etagStringThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.entries.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe number of times the item has been previewed.

Command Example#

!box-create-folder-share-link folder_id="125959916474" as_user="14342567114"

Context Example#

{
"Box": {
"ShareLink": {
"etag": "0",
"id": "125959916474",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": null,
"effective_access": "open",
"effective_permission": "can_preview",
"is_password_enabled": false,
"permissions": {
"can_download": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": null,
"url": "https://app.box.com/s/qmfynlq5bpaq5cn7nnbet8vh9nnsswqi",
"vanity_name": null,
"vanity_url": null
},
"type": "folder"
}
}
}

Human Readable Output#

Folder Share Link for 125959916474#

EtagIdShared LinkType
0125959916474url: 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-link#


Updates a shared link on a folder.

Base Command#

box-update-folder-share-link

Input#

Argument NameDescriptionRequired
folder_idThe unique identifier that represent a folder.Required
as_userThe user who is performing the action.Optional
accessThe level of access for the shared link. Possible values are: open, company, collaborators.Optional
passwordThe password required to access the shared link.Optional
unshared_atThe timestamp at which this shared link will expire.Optional
can_downloadIf the shared link allows for downloading of folders. Possible values are: true, false.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idStringThe ID of the item found.
Box.ShareLink.etagStringThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.entries.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe 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#

{
"Box": {
"ShareLink": {
"etag": "0",
"id": "125959916474",
"shared_link": {
"access": "open",
"download_count": 0,
"download_url": null,
"effective_access": "open",
"effective_permission": "can_preview",
"is_password_enabled": false,
"permissions": {
"can_download": false,
"can_preview": true
},
"preview_count": 0,
"unshared_at": null,
"url": "https://app.box.com/s/uaigc08phyoxnx59nlllecax7mfsrfb1",
"vanity_name": null,
"vanity_url": null
},
"type": "folder"
}
}
}

Human Readable Output#

Folder Share Link for 125959916474#

EtagIdShared LinkType
0125959916474url: 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-link#


Removes a shared link from a folder.

Base Command#

box-remove-folder-share-link

Input#

Argument NameDescriptionRequired
folder_idThe unique identifier that represent a folder.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idStringThe ID of the item found.
Box.ShareLink.etagStringThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.

Command Example#

!box-remove-folder-share-link folder_id="125959916474" as_user="test@test.com"

Context Example#

{
"Box": {
"ShareLink": {
"etag": "0",
"id": "125959916474",
"shared_link": null,
"type": "folder"
}
}
}

Human Readable Output#

Folder Share Link for 125959916474 was removed.#

EtagIdType
0125959916474folder

box-get-folder#


Retrieves details for a folder, including the first 100 entries in the folder.

Base Command#

box-get-folder

Input#

Argument NameDescriptionRequired
folder_idThe unique identifier that represent a folder.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.ShareLink.idNumberThe ID of the item found.
Box.ShareLink.etagNumberThe entry tag for the item found.
Box.ShareLink.typeStringThe type of the item found.
Box.ShareLink.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.ShareLink.nameStringThe name of the item.
Box.ShareLink.sha1StringThe SHA1 hash of the item.
Box.ShareLink.file_version.idNumberThe unique identifier that represent a file version.
Box.ShareLink.file_version.typeStringValue is always file_version.
Box.ShareLink.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.ShareLink.descriptionStringThe description of the item.
Box.ShareLink.sizeNumberThe file size in bytes.
Box.ShareLink.path_collection.total_countNumberThe number of folders in the list.
Box.ShareLink.path_collection.entries.idNumberThe ID of the item found.
Box.ShareLink.path_collection.entries.etagNumberThe entry tag for the item found.
Box.ShareLink.path_collection.entries.typeStringThe type of the item found.
Box.ShareLink.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.ShareLink.path_collection.entries.nameStringThe name of the item.
Box.ShareLink.created_atDateThe date and time when the item was created on Box.
Box.ShareLink.modified_atDateThe date and time when the item was last updated on Box.
Box.ShareLink.trashed_atDateThe time at which the item was put in the trash.
Box.ShareLink.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.ShareLink.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.ShareLink.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.ShareLink.created_by.idNumberThe unique identifier for the user who created the item.
Box.ShareLink.created_by.typeStringValue is always user.
Box.ShareLink.created_by.nameStringThe display name of the user who created the item.
Box.ShareLink.created_by.loginStringThe primary email address of the user who created the item.
Box.ShareLink.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.ShareLink.modified_by.typeStringValue is always user.
Box.ShareLink.modified_by.nameStringThe display name of the user who modified the item.
Box.ShareLink.modified_by.loginStringThe primary email address of the user who modified the item.
Box.ShareLink.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.ShareLink.owned_by.typeStringValue is always user.
Box.ShareLink.owned_by.nameStringThe display name of the user who owns the item.
Box.ShareLink.owned_by.loginStringThe primary email address of the user who owns the item.
Box.ShareLink.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.ShareLink.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.ShareLink.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.ShareLink.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.ShareLink.shared_link.accessStringThe access level for the shared link.
Box.ShareLink.shared_link.effective_accessStringThe effective access level for the shared link.
Box.ShareLink.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.ShareLink.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.ShareLink.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.ShareLink.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.ShareLink.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.ShareLink.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.ShareLink.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.ShareLink.parent.idNumberThe ID of the parent for the item found
Box.ShareLink.parent.etagNumberThe entry tag for the parent of the item found.
Box.ShareLink.parent.typeStringThe type for the parent of the item found.
Box.ShareLink.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.ShareLink.parent.nameStringThe name of the parent of the item.
Box.ShareLink.item_statusStringThe status of the parent of the item.

Command Example#

!box-get-folder folder_id="0" as_user="14342567114"

Context Example#

{
"Box": {
"Folder": {
"content_created_at": null,
"content_modified_at": null,
"created_at": null,
"created_by": {
"id": "",
"login": "",
"name": "",
"type": "user"
},
"description": "",
"etag": null,
"folder_upload_email": null,
"id": "0",
"item_collection": {
"entries": [
{
"etag": "0",
"id": "125959916474",
"name": "My Box Notes",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "128036492321",
"name": "Sample Folder for Docs",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "126452434994",
"name": "Sample Testing Folder",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "127912817927",
"name": "Sample Testing Folder 2",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "126469445717",
"name": "Sample Testing Folder test",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "127304720432",
"name": "Sample Testing Folder test1",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "127109452066",
"name": "test-demo name",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "2",
"file_version": {
"id": "794731944502",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745868717302",
"name": "55555.gif",
"sequence_id": "2",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "802646696736",
"sha1": "f401d87fa1cc4f96a357c564bf0de2e19ccf9d1f",
"type": "file_version"
},
"id": "752998071936",
"name": "customers.jpg",
"sequence_id": "0",
"sha1": "f401d87fa1cc4f96a357c564bf0de2e19ccf9d1f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794713426050",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745851995250",
"name": "image.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794716642653",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745854929853",
"name": "image1.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794719141622",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745857164822",
"name": "image2.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794721102684",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745859107884",
"name": "image3.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794733314512",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745870218112",
"name": "image4.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794736891054",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745873525854",
"name": "image6_please_work.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "2",
"file_version": {
"id": "792056280660",
"sha1": "533a85c782614a6dfe19b83f7d628466ceb00c39",
"type": "file_version"
},
"id": "743439873060",
"name": "new-devs-touching-the-build.gif",
"sequence_id": "2",
"sha1": "533a85c782614a6dfe19b83f7d628466ceb00c39",
"type": "file"
},
{
"etag": "5",
"file_version": {
"id": "794764999514",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file_version"
},
"id": "745898898314",
"name": "testing event1234.gif",
"sequence_id": "5",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file"
},
{
"etag": "3",
"file_version": {
"id": "803108695891",
"sha1": "30d8caa24c8526fa13d80e489ea16ff544d988db",
"type": "file_version"
},
"id": "753421883491",
"name": "vandijk5.gif",
"sequence_id": "3",
"sha1": "30d8caa24c8526fa13d80e489ea16ff544d988db",
"type": "file"
}
],
"limit": 100,
"offset": 0,
"order": [
{
"by": "type",
"direction": "ASC"
},
{
"by": "name",
"direction": "ASC"
}
],
"total_count": 18
},
"item_status": "active",
"modified_at": null,
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "All Files",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": null,
"path_collection": {
"entries": [],
"total_count": 0
},
"purged_at": null,
"sequence_id": null,
"shared_link": null,
"size": 212311360,
"trashed_at": null,
"type": "folder"
}
}
}

Human Readable Output#

Folder overview for 0.#

Created ByIdItem StatusModified ByNameOwned ByPath CollectionSizeType
type: user
id:
name:
login:
0activetype: user
id: 14342567114
name: Jane Doe
login: test@test.com
All Filestype: user
id: 14342567114
name: Jane Doe
login: test@test.com
total_count: 0
entries:
212311360folder

File contents for the folder 0#

EtagIdNameSequence IdType
0125959916474My Box Notes0folder
0128036492321Sample Folder for Docs0folder
0126452434994Sample Testing Folder0folder
0127912817927Sample Testing Folder 20folder
0126469445717Sample Testing Folder test0folder
0127304720432Sample Testing Folder test10folder
0127109452066test-demo name0folder
274586871730255555.gif2file
0752998071936customers.jpg0file
0745851995250image.gif0file
0745854929853image1.gif0file
0745857164822image2.gif0file
0745859107884image3.gif0file
0745870218112image4.gif0file
0745873525854image6_please_work.gif0file
2743439873060new-devs-touching-the-build.gif2file
5745898898314testing event1234.gif5file
3753421883491vandijk5.gif3file

box-list-folder-items#


Retrieves a page of items in a folder.

Base Command#

box-list-folder-items

Input#

Argument NameDescriptionRequired
folder_idThe unique identifier that represent a folder.Required
as_userThe user who is performing the action.Optional
limitThe maximum number of items to return per page. Default is "100".Optional
offsetThe offset of the item at which to begin the response. Default is "0".Optional
sortThe field the results should be sorted by. Possible values are: id, name, date, size. Default is name.Optional

Context Output#

PathTypeDescription
Box.Folder.idNumberThe ID of the folder.
Box.Folder.etagNumberThe entity tag of the folder.
Box.Folder.typeStringValue is always `folder`.
Box.Folder.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Folder.nameStringThe name of the folder.
Box.Folder.sha1StringThe SHA1 has of the folder.
Box.Folder.file_version.idNumberThe unique identifier that represent a file version.
Box.Folder.file_version.typeStringValue is always file_version.
Box.Folder.file_version.sha1StringThe SHA1 hash of this version of the file.

Command Example#

!box-list-folder-items folder_id="0" as_user="test@test.com"

Context Example#

{
"Box": {
"Folder": {
"content_created_at": null,
"content_modified_at": null,
"created_at": null,
"created_by": {
"id": "",
"login": "",
"name": "",
"type": "user"
},
"description": "",
"etag": null,
"folder_upload_email": null,
"id": "0",
"item_collection": {
"entries": [
{
"etag": "0",
"id": "125959916474",
"name": "My Box Notes",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "128036492321",
"name": "Sample Folder for Docs",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "126452434994",
"name": "Sample Testing Folder",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "127912817927",
"name": "Sample Testing Folder 2",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "126469445717",
"name": "Sample Testing Folder test",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "127304720432",
"name": "Sample Testing Folder test1",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "0",
"id": "127109452066",
"name": "test-demo name",
"sequence_id": "0",
"type": "folder"
},
{
"etag": "2",
"file_version": {
"id": "794731944502",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745868717302",
"name": "55555.gif",
"sequence_id": "2",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "802646696736",
"sha1": "f401d87fa1cc4f96a357c564bf0de2e19ccf9d1f",
"type": "file_version"
},
"id": "752998071936",
"name": "customers.jpg",
"sequence_id": "0",
"sha1": "f401d87fa1cc4f96a357c564bf0de2e19ccf9d1f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794713426050",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745851995250",
"name": "image.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794716642653",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745854929853",
"name": "image1.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794719141622",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745857164822",
"name": "image2.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794721102684",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745859107884",
"name": "image3.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794733314512",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745870218112",
"name": "image4.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "0",
"file_version": {
"id": "794736891054",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745873525854",
"name": "image6_please_work.gif",
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file"
},
{
"etag": "2",
"file_version": {
"id": "792056280660",
"sha1": "533a85c782614a6dfe19b83f7d628466ceb00c39",
"type": "file_version"
},
"id": "743439873060",
"name": "new-devs-touching-the-build.gif",
"sequence_id": "2",
"sha1": "533a85c782614a6dfe19b83f7d628466ceb00c39",
"type": "file"
},
{
"etag": "5",
"file_version": {
"id": "794764999514",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file_version"
},
"id": "745898898314",
"name": "testing event1234.gif",
"sequence_id": "5",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file"
},
{
"etag": "3",
"file_version": {
"id": "803108695891",
"sha1": "30d8caa24c8526fa13d80e489ea16ff544d988db",
"type": "file_version"
},
"id": "753421883491",
"name": "vandijk5.gif",
"sequence_id": "3",
"sha1": "30d8caa24c8526fa13d80e489ea16ff544d988db",
"type": "file"
}
],
"limit": 100,
"offset": 0,
"order": [
{
"by": "type",
"direction": "ASC"
},
{
"by": "name",
"direction": "ASC"
}
],
"total_count": 18
},
"item_status": "active",
"modified_at": null,
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "All Files",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": null,
"path_collection": {
"entries": [],
"total_count": 0
},
"purged_at": null,
"sequence_id": null,
"shared_link": null,
"size": 212311360,
"trashed_at": null,
"type": "folder"
}
}
}

Human Readable Output#

Folder overview for 0.#

Created ByIdItem StatusModified ByNameOwned ByPath CollectionSizeType
type: user
id:
name:
login:
0activetype: user
id: 14342567114
name: Jane Doe
login: test@test.com
All Filestype: user
id: 14342567114
name: Jane Doe
login: test@test.com
total_count: 0
entries:
212311360folder

File contents for the folder 0#

EtagIdNameSequence IdType
0125959916474My Box Notes0folder
0128036492321Sample Folder for Docs0folder
0126452434994Sample Testing Folder0folder
0127912817927Sample Testing Folder 20folder
0126469445717Sample Testing Folder test0folder
0127304720432Sample Testing Folder test10folder
0127109452066test-demo name0folder
274586871730255555.gif2file
0752998071936customers.jpg0file
0745851995250image.gif0file
0745854929853image1.gif0file
0745857164822image2.gif0file
0745859107884image3.gif0file
0745870218112image4.gif0file
0745873525854image6_please_work.gif0file
2743439873060new-devs-touching-the-build.gif2file
5745898898314testing event1234.gif5file
3753421883491vandijk5.gif3file

box-folder-create#


Creates a new empty folder within the specified parent folder.

Base Command#

box-folder-create

Input#

Argument NameDescriptionRequired
nameThe name for the new folder.Required
parent_idThe parent folder to create the new folder within. Default is 0.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.Folder.idNumberThe ID of the folder created.
Box.Folder.etagNumberThe entry tag for the folder created.
Box.Folder.typeStringThe type of folder.
Box.Folder.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the folder.
Box.Folder.nameStringThe name of the folder.
Box.Folder.sha1StringThe SHA1 hash of the folder.
Box.Folder.file_version.idNumberThe unique identifier that represents a file version.
Box.Folder.file_version.typeStringValue is always file_version.
Box.Folder.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.Folder.descriptionStringThe description of the item.
Box.Folder.sizeNumberThe folder size in bytes.
Box.Folder.path_collection.total_countNumberThe number of folders in the list.
Box.Folder.path_collection.entries.idNumberThe ID of the item found.
Box.Folder.path_collection.entries.etagNumberThe entry tag for the item found.
Box.Folder.path_collection.entries.typeStringThe type of the item found.
Box.Folder.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Folder.path_collection.entries.nameStringThe name of the item.
Box.Folder.created_atDateThe date and time when the item was created on Box.
Box.Folder.modified_atDateThe date and time when the item was last updated on Box.
Box.Folder.trashed_atDateThe time at which the item was put in the trash.
Box.Folder.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.Folder.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.Folder.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.Folder.created_by.idNumberThe unique identifier for the user who created the item.
Box.Folder.created_by.typeStringValue is always user.
Box.Folder.created_by.nameStringThe display name of the user who created the item.
Box.Folder.created_by.loginStringThe primary email address of the user who created the item.
Box.Folder.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.Folder.modified_by.typeStringValue is always user.
Box.Folder.modified_by.nameStringThe display name of the user who modified the item.
Box.Folder.modified_by.loginStringThe primary email address of the user who modified the item.
Box.Folder.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.Folder.owned_by.typeStringValue is always user.
Box.Folder.owned_by.nameStringThe display name of the user who owns the item.
Box.Folder.owned_by.loginStringThe primary email address of the user who owns the item.
Box.Folder.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.Folder.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.Folder.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.Folder.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.Folder.shared_link.accessStringThe access level for the shared link.
Box.Folder.shared_link.effective_accessStringThe effective access level for the shared link.
Box.Folder.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.Folder.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.Folder.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.Folder.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.Folder.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.Folder.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.Folder.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.Folder.parent.idNumberThe ID of the parent for the item found
Box.Folder.parent.etagNumberThe entry tag for the parent of the item found.
Box.Folder.parent.typeStringThe type for the parent of the item found.
Box.Folder.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.Folder.parent.nameStringThe name of the parent of the item.
Box.Folder.item_statusStringThe 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#

{
"Box": {
"Folder": {
"etag": "0",
"id": "128036492321",
"shared_link": null,
"type": "folder"
}
}
}

Human Readable Output#

Folder named Sample Folder for Docs, was successfully created.

box-file-delete#


Deletes a file, either permanently or by moving it to the trash.

Base Command#

box-file-delete

Input#

Argument NameDescriptionRequired
file_idThe unique identifier that represent a file.Required
as_userThe user who is performing the action.Optional

Context Output#

There is no context output for this command.

Command Example#

!box-file-delete file_id="751526132294" as_user="14342567114"

Context Example#

{}

Human Readable Output#

The file 751526132294 was successfully deleted.

box-list-users#


Returns a list of all users for the Enterprise along with their user_id, public_name, and login.

Base Command#

box-list-users

Input#

Argument NameDescriptionRequired
fieldsAttributes to include in the response. Possible values are: id, type, name.Optional
filter_termLimits the results to only users who's name or login start with the search term.Optional
limitThe maximum number of items to return per page. Default is "100".Optional
offsetThe offset of the item at which to begin the response. Default is "0".Optional

Context Output#

PathTypeDescription
Box.User.idNumberThe unique identifier for this user.
Box.User.typeStringValue is always user.
Box.User.nameStringThe display name of this user.
Box.User.loginStringThe primary email address of this user.
Box.User.created_atDateWhen the user object was created.
Box.User.modified_atDateWhen the user object was last modified.
Box.User.languageStringThe language of the user, formatted in a modified version of the ISO 639-1 format.
Box.User.timezoneStringThe user's timezone.
Box.User.space_amountNumberThe user's total available space amount in bytes.
Box.User.space_usedNumberThe amount of space in use by the user.
Box.User.max_upload_sizeNumberThe maximum individual file size in bytes the user can have.
Box.User.statusStringThe user's account status.
Box.User.job_titleStringThe user's job title.
Box.User.phoneNumberThe users phone number.
Box.User.addressStringThe user's address.
Box.User.avatar_urlStringURL of the user's avatar image
Box.User.notification_email.emailStringThe email address to send the notifications to.
Box.User.notification_email.is_confirmedBooleanSpecifies if this email address has been confirmed.

Command Example#

!box-list-users fields=name filter_term="Andrew"

Context Example#

{
"Box": {
"Users": {
"id": "14342567114",
"name": "Jane Doe",
"type": "user"
}
}
}

Human Readable Output#

The following users were found.#

IdNameType
14342567114Jane Doeuser

box-upload-file#


Uploads a file to the given folder.

Base Command#

box-upload-file

Input#

Argument NameDescriptionRequired
entry_idThe entry ID of the file to upload.Required
as_userThe ID of the user who is performing the action.Optional
file_nameThe name of the file.Optional
folder_idThe ID of the folder the file is being uploaded to. Default is 0/root.Required

Context Output#

PathTypeDescription
Box.File.idNumberThe ID of the item found.
Box.File.etagNumberThe entry tag for the item found.
Box.File.typeStringThe type of the item found.
Box.File.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.File.nameStringThe name of the item.
Box.File.sha1StringThe SHA1 hash of the item.
Box.File.file_version.idNumberThe unique identifier that represent a file version.
Box.File.file_version.typeStringValue is always file_version.
Box.File.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.File.descriptionStringThe description of the item.
Box.File.sizeNumberThe file size in bytes.
Box.File.path_collection.total_countNumberThe number of folders in the list.
Box.File.path_collection.entries.idNumberThe ID of the item found.
Box.File.path_collection.entries.etagNumberThe entry tag for the item found.
Box.File.path_collection.entries.typeStringThe type of the item found.
Box.File.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.File.path_collection.entries.nameStringThe name of the item.
Box.File.created_atDateThe date and time when the item was created on Box.
Box.File.modified_atDateThe date and time when the item was last updated on Box.
Box.File.trashed_atDateThe time at which the item was put in the trash.
Box.File.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.File.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.File.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.File.created_by.idNumberThe unique identifier for the user who created the item.
Box.File.created_by.typeStringValue is always user.
Box.File.created_by.nameStringThe display name of the user who created the item.
Box.File.created_by.loginStringThe primary email address of the user who created the item.
Box.File.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.File.modified_by.typeStringValue is always user.
Box.File.modified_by.nameStringThe display name of the user who modified the item.
Box.File.modified_by.loginStringThe primary email address of the user who modified the item.
Box.File.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.File.owned_by.typeStringValue is always user.
Box.File.owned_by.nameStringThe display name of the user who owns the item.
Box.File.owned_by.loginStringThe primary email address of the user who owns the item.
Box.File.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.File.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.File.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.File.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.File.shared_link.accessStringThe access level for the shared link.
Box.File.shared_link.effective_accessStringThe effective access level for the shared link.
Box.File.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.File.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.File.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.File.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.File.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.File.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.File.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.File.parent.idNumberThe ID of the parent for the item found
Box.File.parent.etagNumberThe entry tag for the parent of the item found.
Box.File.parent.typeStringThe type for the parent of the item found.
Box.File.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.File.parent.nameStringThe name of the parent of the item.
Box.File.item_statusStringThe 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 Output#

File was successfully uploaded

box-trashed-items-list#


Retrieves the files and folders that have been moved to the trash.

Base Command#

box-trashed-items-list

Input#

Argument NameDescriptionRequired
as_userThe user performing the action.Optional
limitThe maximum number of items to return per page. Default is "100".Optional
offsetThe offset of the item at which to begin the response. Default is "0".Optional

Context Output#

PathTypeDescription
Box.Trash.idNumberThe ID of the item found.
Box.Trash.etagNumberThe entry tag for the item found.
Box.Trash.typeStringThe type of the item found.
Box.Trash.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Trash.nameStringThe name of the item.
Box.Trash.sha1StringThe SHA1 hash of the item.
Box.Trash.file_version.idNumberThe unique identifier that represent a file version.
Box.Trash.file_version.typeStringValue is always file_version.
Box.Trash.file_version.sha1StringThe SHA1 hash of this version of the file.

Command Example#

!box-trashed-items-list as_user="14342567114"

Context Example#

{
"Box": {
"Trash": {
"etag": "11",
"file_version": {
"id": "801011020694",
"sha1": "aa58d9692d58f5d9316d7cf1950d19a0b01bc204",
"type": "file_version"
},
"id": "751526132294",
"name": "list.json",
"sequence_id": "11",
"sha1": "aa58d9692d58f5d9316d7cf1950d19a0b01bc204",
"type": "file"
}
}
}

Human Readable Output#

Trashed items were found.#

EtagFile VersionIdNameSequence IdSha1Type
11type: file_version
id: 801011020694
sha1: aa58d9692d58f5d9316d7cf1950d19a0b01bc204
751526132294list.json11aa58d9692d58f5d9316d7cf1950d19a0b01bc204file

box-trashed-item-restore#


Restores a file or folder that has been moved to the trash.

Base Command#

box-trashed-item-restore

Input#

Argument NameDescriptionRequired
item_idThe unique identifier that represents the file or folder.Required
typeType of the object to restore. Possible values are: file, folder.Required
as_userThe user who is performing the action.Optional

Context Output#

PathTypeDescription
Box.Item.idNumberThe ID of the item found.
Box.Item.etagNumberThe entry tag for the item found.
Box.Item.typeStringThe type of the item found.
Box.Item.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Item.nameStringThe name of the item.
Box.Item.sha1StringThe SHA1 hash of the item.
Box.Item.file_version.idNumberThe unique identifier that represent a file version.
Box.Item.file_version.typeStringValue is always file_version.
Box.Item.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.Item.descriptionStringThe description of the item.
Box.Item.sizeNumberThe file size in bytes.
Box.Item.path_collection.total_countNumberThe number of folders in the list.
Box.Item.path_collection.entries.idNumberThe ID of the item found.
Box.Item.path_collection.entries.etagNumberThe entry tag for the item found.
Box.Item.path_collection.entries.typeStringThe type of the item found.
Box.Item.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Item.path_collection.entries.nameStringThe name of the item.
Box.Item.created_atDateThe date and time when the item was created on Box.
Box.Item.modified_atDateThe date and time when the item was last updated on Box.
Box.Item.trashed_atDateThe time at which the item was put in the trash.
Box.Item.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.Item.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.Item.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.Item.created_by.idNumberThe unique identifier for the user who created the item.
Box.Item.created_by.typeStringValue is always user.
Box.Item.created_by.nameStringThe display name of the user who created the item.
Box.Item.created_by.loginStringThe primary email address of the user who created the item.
Box.Item.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.Item.modified_by.typeStringValue is always user.
Box.Item.modified_by.nameStringThe display name of the user who modified the item.
Box.Item.modified_by.loginStringThe primary email address of the user who modified the item.
Box.Item.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.Item.owned_by.typeStringValue is always user.
Box.Item.owned_by.nameStringThe display name of the user who owns the item.
Box.Item.owned_by.loginStringThe primary email address of the user who owns the item.
Box.Item.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.Item.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.Item.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.Item.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.Item.shared_link.accessStringThe access level for the shared link.
Box.Item.shared_link.effective_accessStringThe effective access level for the shared link.
Box.Item.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.Item.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.Item.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.Item.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.Item.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.Item.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.Item.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.Item.parent.idNumberThe ID of the parent for the item found
Box.Item.parent.etagNumberThe entry tag for the parent of the item found.
Box.Item.parent.typeStringThe type for the parent of the item found.
Box.Item.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.Item.parent.nameStringThe name of the parent of the item.
Box.Item.item_statusStringThe status of the parent of the item.

Command Example#

!box-trashed-item-restore item_id="751526132294" type="file" as_user="14342567114"

Context Example#

{
"Box": {
"Item": {
"content_created_at": "2020-12-09T08:49:16-08:00",
"content_modified_at": "2020-12-09T08:49:16-08:00",
"created_at": "2020-12-09T09:16:32-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "12",
"file_version": {
"id": "801011020694",
"sha1": "aa58d9692d58f5d9316d7cf1950d19a0b01bc204",
"type": "file_version"
},
"id": "751526132294",
"item_status": "active",
"modified_at": "2020-12-09T09:16:32-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "list.json",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "12",
"sha1": "aa58d9692d58f5d9316d7cf1950d19a0b01bc204",
"shared_link": null,
"size": 1135,
"trashed_at": null,
"type": "file"
}
}
}

Human Readable Output#

Item with the ID 751526132294 was restored.

box-trashed-item-delete-permanently#


Permanently deletes a file or folder that is in the trash. This action cannot be undone.

Base Command#

box-trashed-item-delete-permanently

Input#

Argument NameDescriptionRequired
item_idThe unique identifier that represents the file or folder.Required
typeThe type of the item to delete. Possible values are: file, folder.Required
as_userThe user who is performing the action.Optional

Context Output#

There is no context output for this command.

Command Example#

Human Readable Output#

box-get-current-user#


Retrieves information about the user who is currently authenticated.

Base Command#

box-get-current-user

Input#

Argument NameDescriptionRequired
as_userThe ID of the user making the request.Optional

Context Output#

PathTypeDescription
Box.User.idNumberThe unique identifier for this user.
Box.User.typeStringValue is always user.
Box.User.nameStringThe display name of this user.
Box.User.loginStringThe primary email address of this user.
Box.User.created_atDateWhen the user object was created.
Box.User.modified_atDateWhen the user object was last modified.
Box.User.languageStringThe language of the user, formatted in a modified version of the ISO 639-1 format.
Box.User.timezoneStringThe users timezone.
Box.User.space_amountNumberThe user's total available space amount in bytes.
Box.User.space_usedNumberThe amount of space in use by the user.
Box.User.max_upload_sizeNumberThe maximum individual file size in bytes the user can have.
Box.User.statusStringThe user's account status.
Box.User.job_titleStringThe user's job title.
Box.User.phoneNumberThe user's phone number.
Box.User.addressStringThe user's address.
Box.User.avatar_urlStringURL of the user's avatar image
Box.User.notification_email.emailStringThe email address to send the notifications to.
Box.User.notification_email.is_confirmedBooleanSpecifies if this email address has been confirmed.

Command Example#

!box-get-current-user as_user="14342567114"

Context Example#

{
"Box": {
"User": {
"address": "",
"avatar_url": "https://app.box.com/api/avatar/large/14342567114",
"created_at": "2020-11-11T04:34:53-08:00",
"id": "14342567114",
"job_title": "",
"language": "en",
"login": "test@test.com",
"max_upload_size": 2147483648,
"modified_at": "2020-12-15T03:58:34-08:00",
"name": "Jane Doe",
"notification_email": [],
"phone": "4808675309",
"space_amount": 10737418240,
"space_used": 212311360,
"status": "active",
"timezone": "America/Los_Angeles",
"type": "user"
}
}
}

Human Readable Output#

The current user is test@test.com.#

Avatar UrlCreated AtIdLanguageLoginMax Upload SizeModified AtNamePhoneSpace AmountSpace UsedStatusTimezoneType
https://app.box.com/api/avatar/large/143425671142020-11-11T04:34:53-08:0014342567114entest@test.com21474836482020-12-15T03:58:34-08:00Jane Doe480867530910737418240212311360activeAmerica/Los_Angelesuser

box-update-user#


Updates a managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Base Command#

box-update-user

Input#

Argument NameDescriptionRequired
roleThe user’s enterprise role. Possible values are: coadmin, user.Optional
addressThe user’s address.Optional
job_titleThe user’s job title.Optional
languageThe language of the user, formatted in a modified version of the ISO 639-1 format.Optional
loginThe email address the user uses to log in.Optional
nameThe name of the user.Optional
phoneThe user’s phone number.Optional
space_amountThe user’s total available space in bytes. Set this to -1 to indicate unlimited storage.Optional
statusThe user's account status. Possible values are: active, inactive, cannot_delete_edit, cannot_delete_edit_upload.Optional
timezoneThe user's timezone.Optional
is_sync_enabledWhether the user can use Box Sync. Possible values are: true, false.Optional
is_exempt_from_device_limitsWhether to exempt the user from enterprise device limits. Possible values are: true, false.Optional
is_external_collab_restrictedWhether the user is allowed to collaborate with users outside their enterprise. Possible values are: true, false.Optional
is_exempt_from_login_verificationWhether the user must use two-factor authentication. Possible values are: true, false.Optional
can_see_managed_usersWhether the user can see other enterprise users in their contact list. Possible values are: true, false.Optional
tracking_codesA tracking code that allows an admin to generate reports from the admin console and assign an attribute to a specific group of users. The expected format is key1:value1,key2:value2. Multiple key value pairs may be used when using the , separator.Optional
user_idThe ID of the user.Required
as_userThe ID of the user who is making the request.Optional

Context Output#

PathTypeDescription
Box.User.idNumberThe unique identifier for this user.
Box.User.typeStringValue is always user.
Box.User.nameStringThe display name of this user.
Box.User.loginStringThe primary email address of this user.
Box.User.created_atDateWhen the user object was created.
Box.User.modified_atDateWhen the user object was last modified.
Box.User.languageStringThe language of the user, formatted in a modified version of the ISO 639-1 format.
Box.User.timezoneStringThe user's timezone.
Box.User.space_amountNumberThe user's total available space amount in bytes.
Box.User.space_usedNumberThe amount of space in use by the user.
Box.User.max_upload_sizeNumberThe maximum individual file size in bytes the user can have.
Box.User.statusStringThe user's account status.
Box.User.job_titleStringThe user's job title.
Box.User.phoneNumberThe user's phone number.
Box.User.addressStringThe user's address.
Box.User.avatar_urlStringURL of the user's avatar image
Box.User.notification_email.emailStringThe email address to send the notifications to.
Box.User.notification_email.is_confirmedBooleanSpecifies if this email address has been confirmed.

Command Example#

!box-update-user phone="4808675309" is_sync_enabled="true" is_exempt_from_device_limits="true" is_external_collab_restricted="false" is_exempt_from_login_verification="false" can_see_managed_users="true" user_id="14342567114" as_user="14342567114"

Context Example#

{
"Box": {
"User": {
"address": "",
"avatar_url": "https://app.box.com/api/avatar/large/14342567114",
"created_at": "2020-11-11T04:34:53-08:00",
"id": "14342567114",
"job_title": "",
"language": "en",
"login": "test@test.com",
"max_upload_size": 2147483648,
"modified_at": "2020-12-15T03:59:04-08:00",
"name": "Jane Doe",
"notification_email": [],
"phone": "4808675309",
"space_amount": 10737418240,
"space_used": 212312495,
"status": "active",
"timezone": "America/Los_Angeles",
"type": "user"
}
}
}

Human Readable Output#

The user test@test.com has been updated.#

Avatar UrlCreated AtIdLanguageLoginMax Upload SizeModified AtNamePhoneSpace AmountSpace UsedStatusTimezoneType
https://app.box.com/api/avatar/large/143425671142020-11-11T04:34:53-08:0014342567114entest@test.com21474836482020-12-15T03:59:04-08:00Jane Doe480867530910737418240212312495activeAmerica/Los_Angelesuser

box-create-user#


Creates a new managed user in an enterprise. This endpoint is only available to users and applications with the right admin permissions.

Base Command#

box-create-user

Input#

Argument NameDescriptionRequired
as_userThe user who is making the request.Optional
loginThe email address the user uses to log in.Optional
nameThe name of the user.Required
roleThe user’s enterprise role. Possible values are: coadmin, user.Optional
languageThe language of the user, formatted in a modified version of the ISO 639-1 format.Optional
is_sync_enabledWhether the user can use Box Sync. Possible values are: true, false.Optional
job_titleThe user’s job title.Optional
phoneThe user’s phone number.Optional
addressThe user’s address.Optional
space_amountThe user’s total available space in bytes. Set this to -1 to indicate unlimited storage.Optional
tracking_codesA tracking code that allows an admin to generate reports from the admin console and assign an attribute to a specific group of users. The expected format is key1:value1,key2:value2. Multiple key value pairs may be used when using the , separator.Optional
can_see_managed_usersWhether the user can see other enterprise users in their contact list. Possible values are: true, false.Optional
timezoneThe user's timezone.Optional
is_exempt_from_device_limitsWhether to exempt the user from enterprise device limits. Possible values are: true, false.Optional
is_exempt_from_login_verificationWhether the user must use two-factor authentication. Possible values are: true, false.Optional
is_external_collab_restrictedWhether the user is allowed to collaborate with users outside their enterprise. Possible values are: true, false.Optional
is_platform_access_onlySpecifies that the user is an app user. Possible values are: true, false.Optional
statusThe user's account status. Possible values are: active, inactive, cannot_delete_edit, cannot_delete_edit_upload.Optional

Context Output#

PathTypeDescription
Box.User.idNumberThe unique identifier for this user.
Box.User.typeStringValue is always user.
Box.User.nameStringThe display name of this user.
Box.User.loginStringThe primary email address of this user.
Box.User.created_atDateWhen the user object was created.
Box.User.modified_atDateWhen the user object was last modified.
Box.User.languageStringThe language of the user, formatted in a modified version of the ISO 639-1 format.
Box.User.timezoneStringThe user's timezone.
Box.User.space_amountNumberThe user's total available space amount in bytes.
Box.User.space_usedNumberThe amount of space in use by the user.
Box.User.max_upload_sizeNumberThe maximum individual file size in bytes the user can have.
Box.User.statusStringThe user's account status.
Box.User.job_titleStringThe user's job title.
Box.User.phoneNumberThe user's phone number.
Box.User.addressStringThe user's address.
Box.User.avatar_urlStringURL of the user's avatar image
Box.User.notification_email.emailStringThe email address to send the notifications to.
Box.User.notification_email.is_confirmedBooleanSpecifies if this email address has been confirmed.

Command Example#

!box-create-user name="some_name_test" is_sync_enabled="false" phone="000000000" can_see_managed_users="false" is_exempt_from_device_limits="true" is_exempt_from_login_verification="false" is_external_collab_restricted="false" is_platform_access_only="true"

Context Example#

{
"Box": {
"User": {
"address": "",
"avatar_url": "https://app.box.com/api/avatar/large/14658591950",
"created_at": "2020-12-15T03:58:28-08:00",
"id": "14658591950",
"job_title": "",
"language": "en",
"login": "AppUser_1403892_rBpFRjYb94@boxdevedition.com",
"max_upload_size": 2147483648,
"modified_at": "2020-12-15T03:58:28-08:00",
"name": "some_name_test",
"notification_email": [],
"phone": "000000000",
"space_amount": 10737418240,
"space_used": 0,
"status": "active",
"timezone": "America/Los_Angeles",
"type": "user"
}
}
}

Human Readable Output#

The user AppUser_1403892_rBpFRjYb94@boxdevedition.com has been created.#

Avatar UrlCreated AtIdLanguageLoginMax Upload SizeModified AtNamePhoneSpace AmountSpace UsedStatusTimezoneType
https://app.box.com/api/avatar/large/146585919502020-12-15T03:58:28-08:0014658591950enAppUser_1403892_rBpFRjYb94@boxdevedition.com21474836482020-12-15T03:58:28-08:00some_name_test000000000107374182400activeAmerica/Los_Angelesuser

box-delete-user#


Deletes a user. By default this will fail if the user still owns any content. Move their owned content first before proceeding, or use the force field to delete the user and their files.

Base Command#

box-delete-user

Input#

Argument NameDescriptionRequired
user_idThe ID of the user.Required
as_userThe user ID of the account making the request.Optional
forceWhether the user should be deleted even if this user still own files. Possible values are: true, false.Optional

Context Output#

There is no context output for this command.

Command Example#

!box-delete-user user_id="14639008448"

Context Example#

{}

Human Readable Output#

The user 14639008448 was successfully deleted.

box-list-user-events#


Returns up to a year of past events for a given user.

Base Command#

box-list-user-events

Input#

Argument NameDescriptionRequired
as_userThe user who is performing the action.Optional
stream_typeThe type of stream to retrieve. Possible values are: all, changes, sync.Required
limitThe maximum number of events to return. Default is "100".Optional

Context Output#

PathTypeDescription
Box.Events.typeStringThe type of the event.
Box.Events.event_idStringThe ID of the event object. You can use this to detect duplicate events.
Box.Events.created_by.typeStringValue is always user.
Box.Events.created_by.idDateThe unique identifier for this user.
Box.Events.created_by.nameStringThe display name of this user.
Box.Events.created_by.loginStringThe primary email address of this user.
Box.Events.created_atDateTime which the event was created.
Box.Events.recorded_atDateTime which the event was recorded.
Box.Events.event_typeStringThe event type that triggered this event.
Box.Events.session_idStringThe session of the user who performed the action. Not all events will populate this attribute.

Command Example#

!box-list-user-events stream_type="all" limit="1"

Context Example#

{
"Box": {
"Events": [
{
"created_at": "2020-11-25T04:12:23-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "821c82f3cf438bf0d206aa80aac526ea1700a46b",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T04:12:24-08:00",
"session_id": "stw7zogl1ohiczrp",
"source": {
"content_created_at": "2020-11-25T04:12:23-08:00",
"content_modified_at": "2020-11-25T04:12:23-08:00",
"created_at": "2020-11-25T04:12:23-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794713426050",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745851995250",
"item_status": "active",
"modified_at": "2020-11-25T04:12:23-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T04:24:37-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "0fcb31e458fd14483cf760e1895ee69980eaff62",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T04:24:37-08:00",
"session_id": "ifhnscgl1ou83ihz",
"source": {
"content_created_at": "2020-11-25T04:24:36-08:00",
"content_modified_at": "2020-11-25T04:24:36-08:00",
"created_at": "2020-11-25T04:24:36-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794716642653",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745854929853",
"item_status": "active",
"modified_at": "2020-11-25T04:24:36-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image1.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T04:34:17-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "3d89043e5c46897ac77702f553622204666120a4",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T04:34:18-08:00",
"session_id": "rn9j4egl1p4a7lts",
"source": {
"content_created_at": "2020-11-25T04:34:16-08:00",
"content_modified_at": "2020-11-25T04:34:16-08:00",
"created_at": "2020-11-25T04:34:16-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794719141622",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745857164822",
"item_status": "active",
"modified_at": "2020-11-25T04:34:16-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image2.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T04:36:04-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "40b93bf6eb12fb167a51cdf03e3c3444a6a265b0",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T04:36:05-08:00",
"session_id": "amo218gl1p65hgdk",
"source": {
"content_created_at": "2020-11-25T04:36:04-08:00",
"content_modified_at": "2020-11-25T04:36:04-08:00",
"created_at": "2020-11-25T04:36:04-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794721102684",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745859107884",
"item_status": "active",
"modified_at": "2020-11-25T04:36:04-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image3.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T05:18:44-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "6a9dee69e8f0fdc81e75fa63b1e9c35b80200481",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T05:18:45-08:00",
"session_id": "e2axvxgl1qejl0ar",
"source": {
"content_created_at": "2020-11-25T05:18:44-08:00",
"content_modified_at": "2020-11-25T05:18:44-08:00",
"created_at": "2020-11-25T05:18:44-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794733314512",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745870218112",
"item_status": "active",
"modified_at": "2020-11-25T05:18:44-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image4.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T05:20:56-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "ba2a5d3dca51a7edefbdf06543295a74bc773cb4",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T05:20:56-08:00",
"session_id": "khuqgfgl1qgtmk0w",
"source": {
"content_created_at": "2020-11-25T05:20:55-08:00",
"content_modified_at": "2020-11-25T05:20:55-08:00",
"created_at": "2020-11-25T05:20:56-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794731944502",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745868717302",
"item_status": "active",
"modified_at": "2020-11-25T05:20:56-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image5.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T05:25:44-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "a56e6d1020c8cfb7ce22a990e6da5192001b1c1e",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T05:25:45-08:00",
"session_id": "yoajnqgl1qltqhfl",
"source": {
"content_created_at": "2020-11-25T05:25:44-08:00",
"content_modified_at": "2020-11-25T05:25:44-08:00",
"created_at": "2020-11-25T05:25:44-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794736891054",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"type": "file_version"
},
"id": "745873525854",
"item_status": "active",
"modified_at": "2020-11-25T05:25:44-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image6_please_work.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f",
"shared_link": null,
"size": 26891788,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T06:47:49-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "e9bbd0c85123ebbb1074664c4176f75e6da8cd7f",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T06:47:50-08:00",
"session_id": "qhq59lgl1sz8a1k3",
"source": {
"content_created_at": "2020-11-25T06:47:49-08:00",
"content_modified_at": "2020-11-25T06:47:49-08:00",
"created_at": "2020-11-25T06:47:49-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794763039912",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file_version"
},
"id": "745897019112",
"item_status": "active",
"modified_at": "2020-11-25T06:47:49-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image7_please_work.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"shared_link": null,
"size": 3653705,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T06:48:49-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "be9d499190f23542227cad001c02d8c2bb22c65c",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T06:49:05-08:00",
"session_id": "w1pn5lgl1t09vsfa",
"source": {
"content_created_at": "2020-11-25T06:48:49-08:00",
"content_modified_at": "2020-11-25T06:48:49-08:00",
"created_at": "2020-11-25T06:48:49-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794764186997",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file_version"
},
"id": "745898101397",
"item_status": "active",
"modified_at": "2020-11-25T06:48:49-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image8_please_work.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"shared_link": null,
"size": 3653705,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
},
{
"created_at": "2020-11-25T06:50:31-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "4ce8a9d707a286ea1c62eb2fcccc399bccc68278",
"event_type": "ITEM_UPLOAD",
"recorded_at": "2020-11-25T06:50:32-08:00",
"session_id": "zlecagl1t21rmdp",
"source": {
"content_created_at": "2020-11-25T06:50:31-08:00",
"content_modified_at": "2020-11-25T06:50:31-08:00",
"created_at": "2020-11-25T06:50:31-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"description": "",
"etag": "0",
"file_version": {
"id": "794764999514",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"type": "file_version"
},
"id": "745898898314",
"item_status": "active",
"modified_at": "2020-11-25T06:50:31-08:00",
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "image9_please_work.gif",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
},
"path_collection": {
"entries": [
{
"etag": null,
"id": "0",
"name": "All Files",
"sequence_id": null,
"type": "folder"
}
],
"total_count": 1
},
"purged_at": null,
"sequence_id": "0",
"sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce",
"shared_link": null,
"size": 3653705,
"synced": true,
"trashed_at": null,
"type": "file"
},
"type": "event"
}
]
}
}

Human Readable Output#

Events found for the user: 14342567114#

Created AtCreated ByEvent IdEvent TypeRecorded AtSession IdSourceType
2020-11-25T04:12:23-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
821c82f3cf438bf0d206aa80aac526ea1700a46bITEM_UPLOAD2020-11-25T04:12:24-08:00stw7zogl1ohiczrptype: file
id: 745851995250
file_version: {"type": "file_version", "id": "794713426050", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T04:12:23-08:00
modified_at: 2020-11-25T04:12:23-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T04:12:23-08:00
content_modified_at: 2020-11-25T04:12:23-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T04:24:37-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
0fcb31e458fd14483cf760e1895ee69980eaff62ITEM_UPLOAD2020-11-25T04:24:37-08:00ifhnscgl1ou83ihztype: file
id: 745854929853
file_version: {"type": "file_version", "id": "794716642653", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image1.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T04:24:36-08:00
modified_at: 2020-11-25T04:24:36-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T04:24:36-08:00
content_modified_at: 2020-11-25T04:24:36-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T04:34:17-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
3d89043e5c46897ac77702f553622204666120a4ITEM_UPLOAD2020-11-25T04:34:18-08:00rn9j4egl1p4a7ltstype: file
id: 745857164822
file_version: {"type": "file_version", "id": "794719141622", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image2.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T04:34:16-08:00
modified_at: 2020-11-25T04:34:16-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T04:34:16-08:00
content_modified_at: 2020-11-25T04:34:16-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T04:36:04-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
40b93bf6eb12fb167a51cdf03e3c3444a6a265b0ITEM_UPLOAD2020-11-25T04:36:05-08:00amo218gl1p65hgdktype: file
id: 745859107884
file_version: {"type": "file_version", "id": "794721102684", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image3.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T04:36:04-08:00
modified_at: 2020-11-25T04:36:04-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T04:36:04-08:00
content_modified_at: 2020-11-25T04:36:04-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T05:18:44-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
6a9dee69e8f0fdc81e75fa63b1e9c35b80200481ITEM_UPLOAD2020-11-25T05:18:45-08:00e2axvxgl1qejl0artype: file
id: 745870218112
file_version: {"type": "file_version", "id": "794733314512", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image4.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T05:18:44-08:00
modified_at: 2020-11-25T05:18:44-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T05:18:44-08:00
content_modified_at: 2020-11-25T05:18:44-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T05:20:56-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
ba2a5d3dca51a7edefbdf06543295a74bc773cb4ITEM_UPLOAD2020-11-25T05:20:56-08:00khuqgfgl1qgtmk0wtype: file
id: 745868717302
file_version: {"type": "file_version", "id": "794731944502", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image5.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T05:20:56-08:00
modified_at: 2020-11-25T05:20:56-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T05:20:55-08:00
content_modified_at: 2020-11-25T05:20:55-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T05:25:44-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
a56e6d1020c8cfb7ce22a990e6da5192001b1c1eITEM_UPLOAD2020-11-25T05:25:45-08:00yoajnqgl1qltqhfltype: file
id: 745873525854
file_version: {"type": "file_version", "id": "794736891054", "sha1": "1ff8be1766d9e16b0b651f89001e8e7375c9e71f"}
sequence_id: 0
etag: 0
sha1: 1ff8be1766d9e16b0b651f89001e8e7375c9e71f
name: image6_please_work.gif
description:
size: 26891788
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T05:25:44-08:00
modified_at: 2020-11-25T05:25:44-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T05:25:44-08:00
content_modified_at: 2020-11-25T05:25:44-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T06:47:49-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
e9bbd0c85123ebbb1074664c4176f75e6da8cd7fITEM_UPLOAD2020-11-25T06:47:50-08:00qhq59lgl1sz8a1k3type: file
id: 745897019112
file_version: {"type": "file_version", "id": "794763039912", "sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce"}
sequence_id: 0
etag: 0
sha1: bd992f78f1f50b4b424b0633870aca5eed3bedce
name: image7_please_work.gif
description:
size: 3653705
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T06:47:49-08:00
modified_at: 2020-11-25T06:47:49-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T06:47:49-08:00
content_modified_at: 2020-11-25T06:47:49-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T06:48:49-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
be9d499190f23542227cad001c02d8c2bb22c65cITEM_UPLOAD2020-11-25T06:49:05-08:00w1pn5lgl1t09vsfatype: file
id: 745898101397
file_version: {"type": "file_version", "id": "794764186997", "sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce"}
sequence_id: 0
etag: 0
sha1: bd992f78f1f50b4b424b0633870aca5eed3bedce
name: image8_please_work.gif
description:
size: 3653705
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T06:48:49-08:00
modified_at: 2020-11-25T06:48:49-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T06:48:49-08:00
content_modified_at: 2020-11-25T06:48:49-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event
2020-11-25T06:50:31-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
4ce8a9d707a286ea1c62eb2fcccc399bccc68278ITEM_UPLOAD2020-11-25T06:50:32-08:00zlecagl1t21rmdptype: file
id: 745898898314
file_version: {"type": "file_version", "id": "794764999514", "sha1": "bd992f78f1f50b4b424b0633870aca5eed3bedce"}
sequence_id: 0
etag: 0
sha1: bd992f78f1f50b4b424b0633870aca5eed3bedce
name: image9_please_work.gif
description:
size: 3653705
path_collection: {"total_count": 1, "entries": [{"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}]}
created_at: 2020-11-25T06:50:31-08:00
modified_at: 2020-11-25T06:50:31-08:00
trashed_at: null
purged_at: null
content_created_at: 2020-11-25T06:50:31-08:00
content_modified_at: 2020-11-25T06:50:31-08:00
created_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
modified_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
shared_link: null
parent: {"type": "folder", "id": "0", "sequence_id": null, "etag": null, "name": "All Files"}
item_status: active
synced: true
event

box-list-enterprise-events#


Returns up to a year of past events for the entire enterprise.

Base Command#

box-list-enterprise-events

Input#

Argument NameDescriptionRequired
as_userThe user who is performing the action.Optional
created_afterThe lower bound date and time to return events for.Optional
limitThe maximum number of events to return. Default is "100".Optional

Context Output#

PathTypeDescription
Box.Events.source.item_typeStringThe type of the item that the event represents.
Box.Events.source.item_idDateThe unique identifier that represents the item.
Box.Events.source.item_nameStringThe name of the item.
Box.Events.source.parent.typeStringValue is always folder.
Box.Events.source.parent.nameStringThe name of the folder.
Box.Events.source.parent.idStringThe unique identifier that represents a folder.
Box.Events.source.owned_by.typeStringValue is always user.
Box.Events.source.owned_by.idDateThe unique identifier for this user.
Box.Events.source.owned_by.nameStringThe display name of this user.
Box.Events.source.owned_by.loginStringThe primary email address of this user.
Box.Events.created_by.typeStringValue is always user.
Box.Events.created_by.idDateThe unique identifier for this user.
Box.Events.created_by.nameStringThe display name of this user.
Box.Events.created_by.loginStringThe primary email address of this user.
Box.Events.created_atDateTime which the event was created.
Box.Events.event_idStringThe ID of the event object. You can use this to detect duplicate events.
Box.Events.event_typeStringThe event type that triggered this event.
Box.Events.ip_addressStringIP address of the user who triggered the event.
Box.Events.typeStringAlways event.

Command Example#

!box-list-enterprise-events created_after="1 day" limit="1"

Context Example#

{
"Box": {
"Events": [
{
"action_by": null,
"additional_details": {
"size": 18860439,
"version_id": "803108695891"
},
"created_at": "2020-12-15T00:44:58-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "451677f7-9c7c-497d-a272-69903c1f6c29",
"event_type": "RENAME",
"ip_address": "37.142.10.140",
"session_id": null,
"source": {
"item_id": "753421883491",
"item_name": "vandijk3.gif",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "0",
"name": "All Files",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"size": 18860439,
"version_id": "803108695891"
},
"created_at": "2020-12-15T00:50:37-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "457eebd9-5b26-4333-a3f9-44f040de7220",
"event_type": "RENAME",
"ip_address": "37.142.10.140",
"session_id": null,
"source": {
"item_id": "753421883491",
"item_name": "vandijk4.gif",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "0",
"name": "All Files",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"size": 18860439,
"version_id": "803108695891"
},
"created_at": "2020-12-15T00:53:33-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "e6b91f7a-3eb3-4968-8aef-7ea90ed46f21",
"event_type": "RENAME",
"ip_address": "37.142.10.140",
"session_id": null,
"source": {
"item_id": "753421883491",
"item_name": "vandijk5.gif",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "0",
"name": "All Files",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING",
"shared_link_id": "2hvls15bpbmrjuo4vks6znrvye6gm6g1",
"size": 92934,
"version_id": "790694844770"
},
"created_at": "2020-12-15T03:07:44-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "16b5dbef-3175-41c1-8486-dc6d279f4c63",
"event_type": "ITEM_SHARED_UPDATE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "742246263170",
"item_name": "download.jpeg",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "125959916474",
"name": "My Box Notes",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING",
"size": 1135,
"version_id": "801011020694"
},
"created_at": "2020-12-15T03:07:54-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "3a30d7f7-ce0d-4a4b-a9f8-c8cbccead2dc",
"event_type": "DELETE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "751526132294",
"item_name": "list.json",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "0",
"name": "All Files",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING",
"size": 92934,
"version_id": "790694844770"
},
"created_at": "2020-12-15T03:08:15-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "a71b25af-df2c-4693-8026-e7b1ecd30af9",
"event_type": "UNSHARE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "742246263170",
"item_name": "download.jpeg",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "125959916474",
"name": "My Box Notes",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING",
"shared_link_id": "tkaz5qjy0hmkr5pvnvhoszcjbtx74j3y",
"size": 92934,
"version_id": "790694844770"
},
"created_at": "2020-12-15T03:11:22-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "dba908b8-3813-4117-bbec-763cdd320748",
"event_type": "SHARE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "742246263170",
"item_name": "download.jpeg",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "125959916474",
"name": "My Box Notes",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING",
"size": 92934,
"version_id": "790694844770"
},
"created_at": "2020-12-15T03:11:50-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "fe379c6f-a85c-452a-8e7a-2c6e24397a75",
"event_type": "UNSHARE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "742246263170",
"item_name": "download.jpeg",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "125959916474",
"name": "My Box Notes",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING"
},
"created_at": "2020-12-15T03:11:52-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "b6b320af-5a8a-4352-9d78-44620ccbc2f7",
"event_type": "UNSHARE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "125959916474",
"item_name": "My Box Notes",
"item_type": "folder",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "0",
"name": "All Files",
"type": "folder"
}
},
"type": "event"
},
{
"action_by": null,
"additional_details": {
"service_id": "1403892",
"service_name": "XSOAR_TESTING",
"size": 1135,
"version_id": "801011020694"
},
"created_at": "2020-12-15T03:11:59-08:00",
"created_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"event_id": "cdc29617-5e30-477f-8a56-0497457c61fb",
"event_type": "UNDELETE",
"ip_address": "176.34.214.130",
"session_id": null,
"source": {
"item_id": "751526132294",
"item_name": "list.json",
"item_type": "file",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"parent": {
"id": "0",
"name": "All Files",
"type": "folder"
}
},
"type": "event"
}
]
}
}

Human Readable Output#

Enterprise Events found.#

Additional DetailsCreated AtCreated ByEvent IdEvent TypeIp AddressSourceType
size: 18860439
version_id: 803108695891
2020-12-15T00:44:58-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
451677f7-9c7c-497d-a272-69903c1f6c29RENAME37.142.10.140item_type: file
item_id: 753421883491
item_name: vandijk3.gif
parent: {"type": "folder", "name": "All Files", "id": "0"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
size: 18860439
version_id: 803108695891
2020-12-15T00:50:37-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
457eebd9-5b26-4333-a3f9-44f040de7220RENAME37.142.10.140item_type: file
item_id: 753421883491
item_name: vandijk4.gif
parent: {"type": "folder", "name": "All Files", "id": "0"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
size: 18860439
version_id: 803108695891
2020-12-15T00:53:33-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
e6b91f7a-3eb3-4968-8aef-7ea90ed46f21RENAME37.142.10.140item_type: file
item_id: 753421883491
item_name: vandijk5.gif
parent: {"type": "folder", "name": "All Files", "id": "0"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
shared_link_id: 2hvls15bpbmrjuo4vks6znrvye6gm6g1
size: 92934
version_id: 790694844770
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:07:44-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
16b5dbef-3175-41c1-8486-dc6d279f4c63ITEM_SHARED_UPDATE176.34.214.130item_type: file
item_id: 742246263170
item_name: download.jpeg
parent: {"type": "folder", "name": "My Box Notes", "id": "125959916474"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
size: 1135
version_id: 801011020694
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:07:54-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
3a30d7f7-ce0d-4a4b-a9f8-c8cbccead2dcDELETE176.34.214.130item_type: file
item_id: 751526132294
item_name: list.json
parent: {"type": "folder", "name": "All Files", "id": "0"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
size: 92934
version_id: 790694844770
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:08:15-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
a71b25af-df2c-4693-8026-e7b1ecd30af9UNSHARE176.34.214.130item_type: file
item_id: 742246263170
item_name: download.jpeg
parent: {"type": "folder", "name": "My Box Notes", "id": "125959916474"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
shared_link_id: tkaz5qjy0hmkr5pvnvhoszcjbtx74j3y
size: 92934
version_id: 790694844770
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:11:22-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
dba908b8-3813-4117-bbec-763cdd320748SHARE176.34.214.130item_type: file
item_id: 742246263170
item_name: download.jpeg
parent: {"type": "folder", "name": "My Box Notes", "id": "125959916474"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
size: 92934
version_id: 790694844770
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:11:50-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
fe379c6f-a85c-452a-8e7a-2c6e24397a75UNSHARE176.34.214.130item_type: file
item_id: 742246263170
item_name: download.jpeg
parent: {"type": "folder", "name": "My Box Notes", "id": "125959916474"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:11:52-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
b6b320af-5a8a-4352-9d78-44620ccbc2f7UNSHARE176.34.214.130item_type: folder
item_id: 125959916474
item_name: My Box Notes
parent: {"type": "folder", "name": "All Files", "id": "0"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event
size: 1135
version_id: 801011020694
service_id: 1403892
service_name: XSOAR_TESTING
2020-12-15T03:11:59-08:00type: user
id: 14342567114
name: Jane Doe
login: test@test.com
cdc29617-5e30-477f-8a56-0497457c61fbUNDELETE176.34.214.130item_type: file
item_id: 751526132294
item_name: list.json
parent: {"type": "folder", "name": "All Files", "id": "0"}
owned_by: {"type": "user", "id": "14342567114", "name": "Jane Doe", "login": "test@test.com"}
event

box-download-file#


Returns the contents of a file in binary format.

Base Command#

box-download-file

Input#

Argument NameDescriptionRequired
file_idThe ID of the file.Required
as_userThe user ID of the account making the request.Optional

Context Output#

There is no context output for this command.

Command Example#

!box-download-file file_id="745898898314" as_user="14342567114"

Context Example#

{}

Human Readable Output#

Uploaded file: TestFile.gif

box-move-folder#


Moves all of the items (files, folders and workflows) owned by a user into another user's account. Only the root folder 0 will be transferred.

Folders can only be moved across users by users with administrative permissions.

This command is performed synchronously which might lead to a slow response when the source user has a large number of items in all of its folders.

Base Command#

box-move-folder

Input#

Argument NameDescriptionRequired
to_user_idThe ID of the user who will receive the folders.Required
from_user_idThe ID of the user who currently owns the folder.Required
notifyDetermines if users should receive email notification for the action performed.Optional

Context Output#

PathTypeDescription
Box.Folder.idNumberThe ID of the folder created.
Box.Folder.etagNumberThe entry tag for the folder created.
Box.Folder.typeStringThe type of folder.
Box.Folder.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the folder.
Box.Folder.nameStringThe name of the folder.
Box.Folder.sha1StringThe SHA1 hash of the folder.
Box.Folder.file_version.idNumberThe unique identifier that represents a file version.
Box.Folder.file_version.typeStringValue is always file_version.
Box.Folder.file_version.sha1StringThe SHA1 hash of this version of the file.
Box.Folder.descriptionStringThe description of the item.
Box.Folder.sizeNumberThe folder size in bytes.
Box.Folder.path_collection.total_countNumberThe number of folders in the list.
Box.Folder.path_collection.entries.idNumberThe ID of the item found.
Box.Folder.path_collection.entries.etagNumberThe entry tag for the item found.
Box.Folder.path_collection.entries.typeStringThe type of the item found.
Box.Folder.path_collection.entries.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the item.
Box.Folder.path_collection.entries.nameStringThe name of the item.
Box.Folder.created_atDateThe date and time when the item was created on Box.
Box.Folder.modified_atDateThe date and time when the item was last updated on Box.
Box.Folder.trashed_atDateThe time at which the item was put in the trash.
Box.Folder.purged_atDateThe time at which the item is expected to be purged from the trash.
Box.Folder.content_created_atDateThe date and time at which the item was originally created, which might be before it was uploaded to Box.
Box.Folder.content_modified_atDateThe date and time at which the item was last updated, which might be before it was uploaded to Box.
Box.Folder.created_by.idNumberThe unique identifier for the user who created the item.
Box.Folder.created_by.typeStringValue is always user.
Box.Folder.created_by.nameStringThe display name of the user who created the item.
Box.Folder.created_by.loginStringThe primary email address of the user who created the item.
Box.Folder.modified_by.idNumberThe unique identifier for the user who modified the item.
Box.Folder.modified_by.typeStringValue is always user.
Box.Folder.modified_by.nameStringThe display name of the user who modified the item.
Box.Folder.modified_by.loginStringThe primary email address of the user who modified the item.
Box.Folder.owned_by.idNumberThe unique identifier for the user who owns the item.
Box.Folder.owned_by.typeStringValue is always user.
Box.Folder.owned_by.nameStringThe display name of the user who owns the item.
Box.Folder.owned_by.loginStringThe primary email address of the user who owns the item.
Box.Folder.shared_link.urlStringThe URL that can be used to access the item on Box.
Box.Folder.shared_link.download_urlStringThe URL that can be used to download the item from Box.
Box.Folder.shared_link.vanity_urlStringThe "Custom URL" that can also be used to preview the item on Box.
Box.Folder.shared_link.vanity_nameStringThe custom name of a shared link, as used in the vanity_url field.
Box.Folder.shared_link.accessStringThe access level for the shared link.
Box.Folder.shared_link.effective_accessStringThe effective access level for the shared link.
Box.Folder.shared_link.effective_permissionStringThe effective permissions for this shared link.
Box.Folder.shared_link.unshared_atDateThe date and time when the link will be unshared.
Box.Folder.shared_link.is_password_enabledBooleanDefines if the shared link requires a password to access the item.
Box.Folder.shared_link.permissions.can_downloadBooleanDefines if the shared link allows for the item to be downloaded.
Box.Folder.shared_link.permissions.can_previewBooleanDefines if the shared link allows for the item to be previewed.
Box.Folder.shared_link.download_countNumberThe number of times the item has been downloaded.
Box.Folder.shared_link.preview_countNumberThe number of times the item has been previewed.
Box.Folder.parent.idNumberThe ID of the parent for the item found
Box.Folder.parent.etagNumberThe entry tag for the parent of the item found.
Box.Folder.parent.typeStringThe type for the parent of the item found.
Box.Folder.parent.sequence_idNumberThe numeric identifier that represents the most recent user event that has been applied to the parent of the item.
Box.Folder.parent.nameStringThe name of the parent of the item.
Box.Folder.item_statusStringThe status of the parent of the item.

Command Example#

!box-move-folder to_user_id="123456" from_user_id="654321" notify="true"

Context Example#

{
"Box": {
"Folder": {
"content_created_at": null,
"content_modified_at": null,
"created_at": null,
"created_by": {
"id": "",
"login": "",
"name": "",
"type": "user"
},
"description": "",
"etag": null,
"folder_upload_email": null,
"id": "0",
"item_status": "active",
"modified_at": null,
"modified_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},
"name": "All Files",
"owned_by": {
"id": "14342567114",
"login": "test@test.com",
"name": "Jane Doe",
"type": "user"
},