# Box

<!-- Generated by tools/catalogue/generate.py from flow.service.workflow 5.0.0-beta.39. Don't edit by hand. -->

# Box

The Box category has 8 tasks. Each entry shows the task's latest revision, the one the palette adds. See [Reading an entry](https://www.useboomerang.io/docs/flow/main/catalogue/overview#reading-an-entry).

## Add Box Folder

Adds a Box folder with the specified name. If no parent folder is provided, then the Box root folder is used.

- **Slug:** `add-box-folder`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box enterprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authentication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Folder Name | `folderName` | Text | Yes |  | New folder's name |
| Parent Folder ID | `parentFolderId` | Text | No |  | The id of the parent folder |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the call |
| `id` | Id of the newly added Box folder |

## Add User To Box Folder

Adds an user to the specified Box folder.

- **Slug:** `add-user-to-box-folder`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Folder Id | `folderId` | Text | Yes |  | Box folder id |
| Email | `email` | Text | Yes |  | The email of the user we want to add to the folder |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box enterprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authentication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Box User Role | `role` | Select | No |  | The user's box role |
| Notify By Email | `notify` | Boolean | No | `true` | Send email notification |
| Can View Path | `viewPath` | Boolean | No | `false` | Allow invitee to see the entire ancestral path |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the invite |

## Download File From Box

Downloads a file from Box to the provided path.

- **Slug:** `download-file-from-box`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box enterprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authnetication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| File ID | `fileId` | Text | Yes |  | Box id of the desired file |
| Path | `file` | Text | Yes |  | Full path of downloaded file |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the download action |

## Get Box Folder Info

Gets the details of a Box folder.

- **Slug:** `get-box-folder-info`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box entreprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authnetication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Folder ID | `folderId` | Text | Yes |  | The id of the desired Box folder |
| Response File Path | `outputFilePath` | Text | No |  | File path to store the output response |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the get box info action |
| `folder` | The folder information |

## List Box Folders

Retrieves and lists an user's Box folders.

- **Slug:** `list-box-folders`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box entreprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key |
| Authentication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Response File Path | `outputFilePath` | Text | No |  | File path to store the output response |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the list box folders action |
| `folders` | The retrieved Box folders information |

## Remove Box Folder

Removes a Box folder.

- **Slug:** `remove-box-folder`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box enterprise id |
| Autentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authentication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Folder ID | `folderId` | Text | Yes |  | The id of the Box folder we want removed |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the remove box folder action |

## Remove User From Box Folder

Removes an user from a Box folder.

- **Slug:** `remove-user-from-box-folder`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box enterprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authentication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Folder ID | `folderId` | Text | Yes |  | The id of the desired Box folder |
| User's email | `email` | Text | Yes |  | The email of the user we want to be removed |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of the remove user from box folder action |

## Upload File To Box

Uploads the file at the specified path to the desired Box folder.

- **Slug:** `upload-file-to-box`
- **Type:** `template`
- **Revision:** 1
- **Image:** `boomerangio/box-service:0.0.18`

**Parameters**

| Label | Name | Type | Required | Default | Helper text |
| --- | --- | --- | --- | --- | --- |
| Authentication - Enterprise ID | `enterpriseId` | Text | Yes |  | Box enterprise id |
| Authentication - Client ID | `clientId` | Text | Yes |  | Box client id |
| Authentication - Client Secret | `clientSecret` | Secured | Yes |  | Box client secret |
| Authentication - Public Key ID | `publicKeyId` | Text | Yes |  | Box public key id |
| Authentication - Private Key | `privateKey` | Secured | Yes |  | Box private key |
| Authentication - Private Key Password | `passphrase` | Secured | Yes |  | Box passphrase |
| Folder ID | `folderId` | Text | Yes |  | The id of the box folder to upload into |
| Path To File | `file` | Text | Yes |  | Full path to desired file |

**Results**

| Name | Description |
| --- | --- |
| `status` | The status of he upload file to box action |
| `id` | The id of the newly uploaded file into Box |