> ## Documentation Index > Fetch the complete documentation index at: https://squad.so/docs/llms.txt > Use this file to discover all available pages before exploring further. # Box > What agents can do in Box at each access level, and how to connect, limit, and disconnect Box. Connect Box so your agents can work in your Box account. You choose an access level for each account, and Squad refuses any agent action outside that level. ## Access levels Each Box account has an access level: **Read-only**, **Read + write**, and **Admin**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**. | Level | The connect window describes this level as | Actions agents can use | | ------------------------------ | ------------------------------------------------- | ---------------------- | | **Read-only** | "Read all files and folders." | 133 of 286 | | **Read + write** (recommended) | "Read, upload, edit, comment, and delete files." | 247 of 286 | | **Admin** | "Read/write plus user and enterprise management." | 286 of 286 | **Read + write** is the recommended level. The connect window selects it for you, and you can choose another level. The Box sign-in page asks you to approve full access to your account. This is expected. Squad does not narrow the sign-in. It checks every agent action against the level you chose, and it refuses actions outside that level. ## What agents can do at each level Each level opens with a short summary in plain tasks, then lists every action it adds, grouped by what the action works on. You do not need to name actions. Ask in plain words, and the agent searches for the matching action. **Find an action.** Open a level and use your browser's find (Ctrl+F, or Cmd+F on a Mac) with a word from the task or part of a slug. Or ask your agent in plain words, for example "What can you do in my Box account?" The agent can search the Box actions for you. Each action shows its name, a one-line description where the Box action catalog has one, and its slug. The slug is the ID that agents use when they call the action. Agents can use 133 of the 286 Box actions at this level: * View policies * View and search templates * View and search files * View collaborators * View and search files and folders * View and search folders * View members * View and manage users * View groups * View links * View versions * View agents All 133 actions at this level: | Action | What it does | Slug | | -------------- | ---------------------------------------------------------------------------------- | -------------------- | | Get AI agent | Retrieves detailed information about a specific AI Agent by its unique identifier. | `BOX_GET_AI_AGENT` | | List AI agents | Lists AI agents based on the provided parameters. | `BOX_LIST_AI_AGENTS` | | Action | What it does | Slug | | --------------------------------- | --------------------------------------------------------------------------- | --------------------------------------- | | List file app item associations | This is a beta feature, which means that its availability might be limited. | `BOX_LIST_FILE_APP_ITEM_ASSOCIATIONS` | | List folder app item associations | This is a beta feature, which means that its availability might be limited. | `BOX_LIST_FOLDER_APP_ITEM_ASSOCIATIONS` | | Action | What it does | Slug | | ---------------------------- | --------------------------------------------------------------- | ---------------------------------- | | List box skill cards on file | List the Box Skills metadata cards that are attached to a file. | `BOX_LIST_BOX_SKILL_CARDS_ON_FILE` | | Action | What it does | Slug | | --------------------------- | ------------------------------------------------------------------- | --------------------------------- | | Get collaboration | Retrieves details of a single collaboration by its ID. | `BOX_GET_COLLABORATION` | | List file collaborations | Retrieves a list of pending and active collaborations for a file. | `BOX_LIST_FILE_COLLABORATIONS` | | List folder collaborations | Retrieves a list of pending and active collaborations for a folder. | `BOX_LIST_FOLDER_COLLABORATIONS` | | List group collaborations | Retrieves all the collaborations for a group. | `BOX_LIST_GROUP_COLLABORATIONS` | | List pending collaborations | Retrieves all pending collaboration invites for this user. | `BOX_LIST_PENDING_COLLABORATIONS` | | Action | What it does | Slug | | -------------------- | -------------------------------------------------------------------- | -------------------------- | | Get collection | Retrieves details of a specific collection by its unique identifier. | `BOX_GET_COLLECTION` | | List all collections | Retrieves all collections for a given user. | `BOX_LIST_ALL_COLLECTIONS` | | Action | What it does | Slug | | ------------------ | ---------------------------------------------------------------------------------------------------------------------- | ------------------------ | | Get comment | Retrieves the message and metadata for a specific comment, as well as information on the user who created the comment. | `BOX_GET_COMMENT` | | List file comments | Retrieves a list of comments for a file. | `BOX_LIST_FILE_COMMENTS` | | Action | What it does | Slug | | ------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------ | | Search for content | Searches for files, folders, web links, and shared files across the users content or across the entire enterprise. | `BOX_SEARCH_FOR_CONTENT` | | Action | What it does | Slug | | ---------------------------------- | --------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | Get allowed collaboration domain | Retrieves details of a specific allowed collaboration domain entry within your enterprise. | `BOX_GET_ALLOWED_COLLABORATION_DOMAIN` | | List allowed collaboration domains | Returns the list domains that have been deemed safe to create collaborations for within the current enterprise. | `BOX_LIST_ALLOWED_COLLABORATION_DOMAINS` | | Action | What it does | Slug | | ----------------------- | --------------------------------------- | ----------------------------- | | List user email aliases | Retrieves all email aliases for a user. | `BOX_LIST_USER_EMAIL_ALIASES` | | Action | What it does | Slug | | ----------------------------- | ---------------------------------------------------------------------------------- | ----------------------------------- | | Get events long poll endpoint | Returns a list of real-time servers that can be used for long-polling user events. | `BOX_GET_EVENTS_LONG_POLL_ENDPOINT` | | List events | Returns up to a year of past events for a given user or for the entire enterprise. | `BOX_LIST_EVENTS` | | Action | What it does | Slug | | ------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | | Download file | Returns the contents of a file in binary format. | `BOX_DOWNLOAD_FILE` | | Find file for shared link | Returns the file represented by a shared link. | `BOX_FIND_FILE_FOR_SHARED_LINK` | | Get file information | Retrieves the details about a file. | `BOX_GET_FILE_INFORMATION` | | Get file request | Retrieves detailed information about a file request in Box. | `BOX_GET_FILE_REQUEST` | | Get files under retention | Returns a paginated list of files under retention for a specific retention policy assignment. | `BOX_GET_FILES_UNDER_RETENTION` | | Get metadata instance on file | Retrieves a specific metadata template instance that has been applied to a file. | `BOX_GET_METADATA_INSTANCE_ON_FILE` | | Get retention on file | Returns information about a file version retention. | `BOX_GET_RETENTION_ON_FILE` | | Get trashed file | Retrieves a file that has been moved to the trash. | `BOX_GET_TRASHED_FILE` | | Get watermark on file | Retrieve the watermark for a file. | `BOX_GET_WATERMARK_ON_FILE` | | List files on legal hold policy assignment | Get a list of files with current file versions for a legal hold assignment. | `BOX_LIST_FILES_ON_LEGAL_HOLD_POLICY_ASSIGNMENT` | | List metadata instances on file | Retrieves all metadata instances applied to a file. | `BOX_LIST_METADATA_INSTANCES_ON_FILE` | | Preflight check before upload | Performs a preflight check to verify that a file will be accepted by Box before uploading the entire file. | `BOX_PREFLIGHT_CHECK_BEFORE_UPLOAD` | | Action | What it does | Slug | | ----------------------------- | -------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------- | | Find app item for shared link | Returns the file, folder, web link, or app item represented by a shared link. | `BOX_FIND_APP_ITEM_FOR_SHARED_LINK` | | List collection items | Retrieves the files and/or folders contained within a Box collection. | `BOX_LIST_COLLECTION_ITEMS` | | List items in folder | Retrieves a page of items in a folder. | `BOX_LIST_ITEMS_IN_FOLDER` | | List recently accessed items | Returns information about the recent items accessed by a user, either in the last 90 days or up to the last 1000 items accessed. | `BOX_LIST_RECENTLY_ACCESSED_ITEMS` | | List trashed items | Retrieves the files and folders that have been moved to the trash. | `BOX_LIST_TRASHED_ITEMS` | | Action | What it does | Slug | | --------------------------------- | -------------------------------------------------------------------------------- | --------------------------------------- | | Find folder for shared link | Return the folder represented by a shared link. | `BOX_FIND_FOLDER_FOR_SHARED_LINK` | | Get folder | Retrieves details for a folder, including the first 100 entries in the folder. | `BOX_GET_FOLDER` | | Get metadata instance on folder | Retrieves the instance of a metadata template that has been applied to a folder. | `BOX_GET_METADATA_INSTANCE_ON_FOLDER` | | Get trashed folder | Retrieves a folder that has been moved to the trash. | `BOX_GET_TRASHED_FOLDER` | | Get watermark on folder | Retrieve the watermark for a folder. | `BOX_GET_WATERMARK_ON_FOLDER` | | List folder locks | Retrieves folder lock details for a given folder. | `BOX_LIST_FOLDER_LOCKS` | | List metadata instances on folder | Retrieves all metadata for a given folder. | `BOX_LIST_METADATA_INSTANCES_ON_FOLDER` | | Query files folders by metadata | Query files and folders by metadata using SQL-like syntax. | `BOX_QUERY_FILES_FOLDERS_BY_METADATA` | | Action | What it does | Slug | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ---------------------------- | | Get group | Retrieves information about a group. | `BOX_GET_GROUP` | | List enterprise groups | Retrieves all of the groups for a given enterprise. | `BOX_LIST_ENTERPRISE_GROUPS` | | List user groups | Retrieves all group memberships for a user, including the groups they belong to and their role in each group (member or admin). | `BOX_LIST_USER_GROUPS` | | Action | What it does | Slug | | ------------------------------- | -------------------------------------------------------- | ------------------------------------- | | List Slack integration mappings | Lists Slack integration mappings in a users' enterprise. | `BOX_LIST_SLACK_INTEGRATION_MAPPINGS` | | List teams integration mappings | Lists Teams integration mappings in a users' enterprise. | `BOX_LIST_TEAMS_INTEGRATION_MAPPINGS` | | Action | What it does | Slug | | ---------------------- | ------------------------------------ | ---------------------------- | | Get user invite status | Returns the status of a user invite. | `BOX_GET_USER_INVITE_STATUS` | | Action | What it does | Slug | | -------------------- | ----------------------------------------------------------------- | -------------------------- | | Get shared web link | Retrieve web link information for a shared link. | `BOX_GET_SHARED_WEB_LINK` | | Get trashed web link | Retrieves a web link that has been moved to the trash. | `BOX_GET_TRASHED_WEB_LINK` | | Get web link | Retrieve detailed information about a web link (bookmark) in Box. | `BOX_GET_WEB_LINK` | | Action | What it does | Slug | | --------------------------------------------------- | ------------------------------------------------------------------------------- | --------------------------------------------------------- | | Get group membership | Retrieves a specific group membership. | `BOX_GET_GROUP_MEMBERSHIP` | | Get shield information barrier segment member by ID | Retrieves a shield information barrier segment member by its unique ID. | `BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID` | | List group members | Retrieves all the members for a group. | `BOX_LIST_GROUP_MEMBERS` | | List shield information barrier segment members | Lists shield information barrier segment members based on provided segment IDs. | `BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBERS` | | Action | What it does | Slug | | ---------------------------------- | ----------------------------------------------------------------------------------------- | ---------------------------------------- | | Get legal hold policy | Retrieve detailed information about a specific legal hold policy by its ID. | `BOX_GET_LEGAL_HOLD_POLICY` | | Get legal hold policy assignment | Retrieves detailed information about a specific legal hold policy assignment by its ID. | `BOX_GET_LEGAL_HOLD_POLICY_ASSIGNMENT` | | Get metadata cascade policy | Retrieve a specific metadata cascade policy assigned to a folder. | `BOX_GET_METADATA_CASCADE_POLICY` | | Get retention policy | Retrieves a retention policy by its unique ID. | `BOX_GET_RETENTION_POLICY` | | Get retention policy assignment | Retrieves a retention policy assignment by its unique ID. | `BOX_GET_RETENTION_POLICY_ASSIGNMENT` | | Get storage policy | Fetches a specific storage policy by its ID. | `BOX_GET_STORAGE_POLICY` | | Get storage policy assignment | Retrieves information about a specific storage policy assignment. | `BOX_GET_STORAGE_POLICY_ASSIGNMENT` | | List legal hold policies | Retrieves a list of legal hold policies that belong to an enterprise. | `BOX_LIST_LEGAL_HOLD_POLICIES` | | List legal hold policy assignments | Retrieves a list of items a legal hold policy has been assigned to. | `BOX_LIST_LEGAL_HOLD_POLICY_ASSIGNMENTS` | | List metadata cascade policies | Retrieves a list of all the metadata cascade policies that are applied to a given folder. | `BOX_LIST_METADATA_CASCADE_POLICIES` | | List retention policies | Retrieves all of the retention policies for an enterprise. | `BOX_LIST_RETENTION_POLICIES` | | List retention policy assignments | Retrieves all retention policy assignments for a specified retention policy. | `BOX_LIST_RETENTION_POLICY_ASSIGNMENTS` | | List storage policies | Fetches all the storage policies in the enterprise. | `BOX_LIST_STORAGE_POLICIES` | | List storage policy assignments | Fetches all the storage policy assignment for an enterprise or user. | `BOX_LIST_STORAGE_POLICY_ASSIGNMENTS` | | Action | What it does | Slug | | --------------- | ----------------------------------------- | --------------------- | | Get user avatar | Retrieves the avatar image of a Box user. | `BOX_GET_USER_AVATAR` | | Action | What it does | Slug | | ------------ | ------------------------------------------- | ------------------ | | Ask question | Ask questions about Box files using Box AI. | `BOX_ASK_QUESTION` | | Action | What it does | Slug | | ------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------- | | Get shield information barrier report by ID | Retrieves a shield information barrier report by its ID. | `BOX_GET_SHIELD_INFORMATION_BARRIER_REPORT_BY_ID` | | List shield information barrier reports | Lists shield information barrier reports for a specified barrier. | `BOX_LIST_SHIELD_INFORMATION_BARRIER_REPORTS` | | Action | What it does | Slug | | -------------------------------------------------------- | -------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | Get shield information barrier segment by ID | Retrieves a shield information barrier segment by its unique identifier. | `BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_BY_ID` | | Get shield information barrier segment restriction by ID | Retrieves a shield information barrier segment restriction by its unique ID. | `BOX_GET_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION_BY_ID` | | List shield information barrier segment restrictions | Lists all shield information barrier segment restrictions for a specific segment. | `BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTIONS` | | List shield information barrier segments | Retrieves a list of shield information barrier segment objects for the specified Information Barrier ID. | `BOX_LIST_SHIELD_INFORMATION_BARRIER_SEGMENTS` | | Action | What it does | Slug | | ---------------------- | -------------------------------------------------------------------------- | ---------------------------- | | Get terms of service | Retrieves a specific terms of service by its unique identifier. | `BOX_GET_TERMS_OF_SERVICE` | | List terms of services | Returns the current terms of service text and settings for the enterprise. | `BOX_LIST_TERMS_OF_SERVICES` | | Action | What it does | Slug | | ------------------------- | ---------------------------------------------------------------------------- | ------------------------------- | | Get upload session | Retrieves detailed information about an existing chunked upload session. | `BOX_GET_UPLOAD_SESSION` | | List upload session parts | List the parts (chunks) that have been uploaded to a chunked upload session. | `BOX_LIST_UPLOAD_SESSION_PARTS` | | Action | What it does | Slug | | ---------------------------------- | ---------------------------------------------------------------- | ---------------------------------------- | | Get AI agent default configuration | Retrieve the default AI agent configuration for a specific mode. | `BOX_GET_AI_AGENT_DEFAULT_CONFIGURATION` | | Action | What it does | Slug | | -------------------------- | ------------------------------------------------- | -------------------------------- | | Get shared link for file | Retrieves the shared link information for a file. | `BOX_GET_SHARED_LINK_FOR_FILE` | | Get shared link for folder | Retrieves shared link information for a folder. | `BOX_GET_SHARED_LINK_FOR_FOLDER` | | Action | What it does | Slug | | --------------------- | ----------------------------------------------------------------------- | --------------------------- | | Get task | Retrieves detailed information about a specific task in Box. | `BOX_GET_TASK` | | Get task assignment | Retrieves detailed information about a specific task assignment in Box. | `BOX_GET_TASK_ASSIGNMENT` | | List task assignments | Lists all of the assignments for a given task. | `BOX_LIST_TASK_ASSIGNMENTS` | | List tasks on file | Retrieves a list of all the tasks for a file. | `BOX_LIST_TASKS_ON_FILE` | | Action | What it does | Slug | | ------------------------------------- | --------------------------------------------------------------------- | ------------------------------------------- | | Get metadata taxonomies for namespace | Retrieves all metadata taxonomies within a specific namespace. | `BOX_GET_METADATA_TAXONOMIES_FOR_NAMESPACE` | | Get metadata taxonomy by taxonomy key | Retrieves a metadata taxonomy by its namespace and taxonomy key. | `BOX_GET_METADATA_TAXONOMY_BY_TAXONOMY_KEY` | | Get metadata taxonomy node by ID | Retrieves a specific node from a metadata taxonomy by its identifier. | `BOX_GET_METADATA_TAXONOMY_NODE_BY_ID` | | List metadata taxonomy nodes | Retrieves metadata taxonomy nodes based on the specified parameters. | `BOX_LIST_METADATA_TAXONOMY_NODES` | | Action | What it does | Slug | | ------------------------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------------------------- | | Find metadata template by instance ID | Finds a metadata template by searching for the ID of an instance of the template. | `BOX_FIND_METADATA_TEMPLATE_BY_INSTANCE_ID` | | Get box sign template | Retrieves details of a specific Box Sign template by its unique ID. | `BOX_GET_BOX_SIGN_TEMPLATE` | | Get metadata template by ID | Retrieves a metadata template by its ID. | `BOX_GET_METADATA_TEMPLATE_BY_ID` | | Get metadata template by name | Retrieves a metadata template by its scope and templateKey values. | `BOX_GET_METADATA_TEMPLATE_BY_NAME` | | List all global metadata templates | Used to retrieve all generic, global metadata templates available to all enterprises using Box. | `BOX_LIST_ALL_GLOBAL_METADATA_TEMPLATES` | | List box sign templates | Gets Box Sign templates created by a user. | `BOX_LIST_BOX_SIGN_TEMPLATES` | | List enterprise metadata templates | Used to retrieve all metadata templates created to be used specifically within the user's enterprise. | `BOX_LIST_ENTERPRISE_METADATA_TEMPLATES` | | Action | What it does | Slug | | ------------------ | ------------------------------------------------------------------ | ------------------------ | | Get file thumbnail | Retrieves a thumbnail, or smaller image representation, of a file. | `BOX_GET_FILE_THUMBNAIL` | | Action | What it does | Slug | | -------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------- | | Authorize user | Authorize a user by sending them through the Box website and request their permission to act on their behalf. | `BOX_AUTHORIZE_USER` | | Get current user | Retrieves information about the user who is currently authenticated. | `BOX_GET_CURRENT_USER` | | Get user | Retrieves information about a user in the enterprise. | `BOX_GET_USER` | | Get user exempt from collaboration domain restrictions | Retrieves details of a specific user exemption from collaboration domain restrictions. | `BOX_GET_USER_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS` | | List enterprise users | Returns a list of all users for the Enterprise along with their user\_id, public\_name, and login. | `BOX_LIST_ENTERPRISE_USERS` | | List terms of service user statuses | Retrieves a list of users and their acceptance status for a specific terms of service. | `BOX_LIST_TERMS_OF_SERVICE_USER_STATUSES` | | List users exempt from collaboration domain restrictions | Returns a list of users who have been exempt from the collaboration domain restrictions. | `BOX_LIST_USERS_EXEMPT_FROM_COLLABORATION_DOMAIN_RESTRICTIONS` | | Action | What it does | Slug | | --------------------------------- | ---------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | | Get file version | Retrieve detailed information about a specific version of a file. | `BOX_GET_FILE_VERSION` | | Get file version legal hold | Retrieves detailed information about a specific file version legal hold by its ID. | `BOX_GET_FILE_VERSION_LEGAL_HOLD` | | Get file versions under retention | Returns a list of file versions under retention for a specified retention policy assignment. | `BOX_GET_FILE_VERSIONS_UNDER_RETENTION` | | List all file versions | Retrieve a list of the past versions for a file. | `BOX_LIST_ALL_FILE_VERSIONS` | | List file version legal holds | Get a list of file versions on legal hold for a legal hold assignment. | `BOX_LIST_FILE_VERSION_LEGAL_HOLDS` | | List file version retentions | Retrieves all file version retentions for the given enterprise. | `BOX_LIST_FILE_VERSION_RETENTIONS` | | List hold file versions | Retrieves a list of previous (non-current) file versions that are on legal hold for a specific legal hold policy assignment. | `BOX_LIST_HOLD_FILE_VERSIONS` | | Action | What it does | Slug | | ------------- | ------------------------------------------------------------------ | ------------------- | | Get webhook | Retrieves detailed information about a specific webhook by its ID. | `BOX_GET_WEBHOOK` | | List webhooks | Returns all defined webhooks for the requesting application. | `BOX_LIST_WEBHOOKS` | | Action | What it does | Slug | | -------------- | ----------------------------------------------------------- | -------------------- | | List workflows | Lists Box Relay workflows configured for a specific folder. | `BOX_LIST_WORKFLOWS` | | Action | What it does | Slug | | ------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------------------------------------ | | Download ZIP archive | Downloads a zip archive containing files and/or folders from Box. | `BOX_DOWNLOAD_ZIP_ARCHIVE` | | Extract metadata freeform | Extract metadata from Box files using AI with freeform prompts. | `BOX_EXTRACT_METADATA_FREEFORM` | | Extract metadata structured | Extract structured metadata from files using Box AI. | `BOX_EXTRACT_METADATA_STRUCTURED` | | Generate text | Generate text using Box AI based on a prompt and file context. | `BOX_GENERATE_TEXT` | | Get box sign request | Retrieves the details of a specific Box Sign request by its unique ID. | `BOX_GET_BOX_SIGN_REQUEST` | | Get device pin | Retrieves information about an individual device pin in the enterprise. | `BOX_GET_DEVICE_PIN` | | Get shield information barrier by ID | Retrieves a shield information barrier by its unique ID. | `BOX_GET_SHIELD_INFORMATION_BARRIER_BY_ID` | | Get ZIP download status | Get the download status of a zip archive, including progress, skipped items, and current state. | `BOX_GET_ZIP_DOWNLOAD_STATUS` | | List all classifications | Retrieves the classification metadata template and lists all the classifications available to this enterprise. | `BOX_LIST_ALL_CLASSIFICATIONS` | | List box sign requests | Gets signature requests created by a user. | `BOX_LIST_BOX_SIGN_REQUESTS` | | List enterprise device pins | Retrieves all the device pins within an enterprise. | `BOX_LIST_ENTERPRISE_DEVICE_PINS` | | List hubs | List all Box Hubs for the authenticated user or enterprise. | `BOX_LIST_HUBS` | | List shield information barriers | Retrieves a list of shield information barrier objects for the enterprise of JWT. | `BOX_LIST_SHIELD_INFORMATION_BARRIERS` | Agents can use 247 of the 286 Box actions at this level: everything in **Read-only**, plus: * Create and update policies * Create, update, and delete files * Create, update, and delete folders * Update and delete shared links * Create, update, and delete links * Create and delete sessions * Create, update, and delete tasks * Create, update, and delete versions * Create and update cards * Create, update, and delete comments * Create and update agents * Create and update collaborators The 114 actions that this level adds to **Read-only**: | Action | What it does | Slug | | --------------- | ----------------------------------------------------- | --------------------- | | Create AI agent | Creates a custom AI agent in Box AI Studio. | `BOX_CREATE_AI_AGENT` | | Update AI agent | Updates an existing custom AI agent in Box AI Studio. | `BOX_UPDATE_AI_AGENT` | | Action | What it does | Slug | | ---------------------------------- | ------------------------------------------------------------------------------------- | ---------------------------------------- | | Create box skill cards on file | Applies one or more Box Skills metadata cards to a file. | `BOX_CREATE_BOX_SKILL_CARDS_ON_FILE` | | Update all box skill cards on file | An alternative method to overwrite and update all Box Skill metadata cards on a file. | `BOX_UPDATE_ALL_BOX_SKILL_CARDS_ON_FILE` | | Update box skill cards on file | Updates one or more Box Skills metadata cards on a file using JSON-Patch format. | `BOX_UPDATE_BOX_SKILL_CARDS_ON_FILE` | | Action | What it does | Slug | | -------------------- | ----------------------------------------------------------------------------- | -------------------------- | | Create collaboration | Adds a collaboration for a single user or a single group to a file or folder. | `BOX_CREATE_COLLABORATION` | | Update collaboration | Updates a collaboration. | `BOX_UPDATE_COLLABORATION` | | Action | What it does | Slug | | -------------- | --------------------------------------------------------------------------------- | -------------------- | | Create comment | Adds a comment by the user to a specific file, or as a reply to an other comment. | `BOX_CREATE_COMMENT` | | Delete comment | Permanently deletes a comment from a file or folder in Box. | `BOX_DELETE_COMMENT` | | Update comment | Update the message of a comment. | `BOX_UPDATE_COMMENT` | | Action | What it does | Slug | | -------------------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------- | | Add allowed collaboration domain | Creates a new entry in the list of allowed domains for collaboration within your enterprise. | `BOX_ADD_ALLOWED_COLLABORATION_DOMAIN` | | Action | What it does | Slug | | ------------------ | ----------------------------------------- | ------------------------ | | Create email alias | Adds a new email alias to a user account. | `BOX_CREATE_EMAIL_ALIAS` | | Action | What it does | Slug | | ---------------------------------- | -------------------------------------------------------------------------------------------- | ---------------------------------------- | | Add classification to file | Adds a classification to a file by specifying the label of the classification to add. | `BOX_ADD_CLASSIFICATION_TO_FILE` | | Apply watermark to file | Applies or update a watermark on a file. | `BOX_APPLY_WATERMARK_TO_FILE` | | Copy file | Creates a copy of a file. | `BOX_COPY_FILE` | | Copy file request | Copies an existing file request to a new folder. | `BOX_COPY_FILE_REQUEST` | | Create metadata instance on file | Applies an instance of a metadata template to a file. | `BOX_CREATE_METADATA_INSTANCE_ON_FILE` | | Delete file | Deletes a file from Box by moving it to trash or permanently (based on enterprise settings). | `BOX_DELETE_FILE` | | Delete file request | Deletes a file request permanently. | `BOX_DELETE_FILE_REQUEST` | | Delete metadata instance from file | Removes a metadata instance from a file. | `BOX_DELETE_METADATA_INSTANCE_FROM_FILE` | | Restore file | Restores a file that has been moved to the trash. | `BOX_RESTORE_FILE` | | Update file | Updates a file. | `BOX_UPDATE_FILE` | | Update file request | Updates a file request in Box. | `BOX_UPDATE_FILE_REQUEST` | | Update metadata instance on file | Updates a metadata instance on a file using JSON-Patch operations. | `BOX_UPDATE_METADATA_INSTANCE_ON_FILE` | | Upload file | Uploads a small file to Box. | `BOX_UPLOAD_FILE` | | Upload part of file | Uploads a chunk of a file for an upload session. | `BOX_UPLOAD_PART_OF_FILE` | | Action | What it does | Slug | | ------------------------------------ | --------------------------------------------------------------------------------------------- | ------------------------------------------ | | Add classification to folder | Adds a classification to a folder by specifying the label of the classification to add. | `BOX_ADD_CLASSIFICATION_TO_FOLDER` | | Apply watermark to folder | Applies or update a watermark on a folder. | `BOX_APPLY_WATERMARK_TO_FOLDER` | | Copy folder | Creates a copy of a folder within a destination folder. | `BOX_COPY_FOLDER` | | Create folder | Creates a new empty folder within the specified parent folder. | `BOX_CREATE_FOLDER` | | Create folder lock | Creates a folder lock on a folder, preventing it from being moved and/or deleted. | `BOX_CREATE_FOLDER_LOCK` | | Create metadata instance on folder | Applies an instance of a metadata template to a folder. | `BOX_CREATE_METADATA_INSTANCE_ON_FOLDER` | | Delete folder | Deletes a folder, either permanently or by moving it to the trash. | `BOX_DELETE_FOLDER` | | Delete folder lock | Deletes a folder lock on a given folder, removing restrictions on move and delete operations. | `BOX_DELETE_FOLDER_LOCK` | | Delete metadata instance from folder | Remove a metadata instance from a folder. | `BOX_DELETE_METADATA_INSTANCE_FROM_FOLDER` | | Restore folder | Restores a folder that has been moved to the trash. | `BOX_RESTORE_FOLDER` | | Update folder | Updates a folder. | `BOX_UPDATE_FOLDER` | | Update metadata instance on folder | Updates metadata on a folder using JSON-Patch operations (RFC 6902). | `BOX_UPDATE_METADATA_INSTANCE_ON_FOLDER` | | Action | What it does | Slug | | ------------ | ---------------------------------------------- | ------------------ | | Create group | Creates a new group of users in an enterprise. | `BOX_CREATE_GROUP` | | Update group | Updates a specific group. | `BOX_UPDATE_GROUP` | | Action | What it does | Slug | | -------------------------------- | ------------------------------------------------------------------------------------------------- | -------------------------------------- | | Create Slack integration mapping | Creates a Slack integration mapping by mapping a Slack channel to a Box item. | `BOX_CREATE_SLACK_INTEGRATION_MAPPING` | | Create teams integration mapping | Creates a Microsoft Teams integration mapping that links a Teams channel or team to a Box folder. | `BOX_CREATE_TEAMS_INTEGRATION_MAPPING` | | Update Slack integration mapping | Updates an existing Slack integration mapping. | `BOX_UPDATE_SLACK_INTEGRATION_MAPPING` | | Update teams integration mapping | Updates a Microsoft Teams integration mapping that links a Box folder to a Teams channel. | `BOX_UPDATE_TEAMS_INTEGRATION_MAPPING` | | Action | What it does | Slug | | ------------------ | -------------------------------------------------------- | ------------------------ | | Create user invite | Invites an existing external user to join an enterprise. | `BOX_CREATE_USER_INVITE` | | Action | What it does | Slug | | ---------------- | ----------------------------------------------------- | ---------------------- | | Create web link | Creates a web link object within a folder. | `BOX_CREATE_WEB_LINK` | | Delete web link | Deletes a web link. | `BOX_DELETE_WEB_LINK` | | Restore web link | Restores a web link that has been moved to the trash. | `BOX_RESTORE_WEB_LINK` | | Update web link | Updates a web link object. | `BOX_UPDATE_WEB_LINK` | | Action | What it does | Slug | | ------------------------------------------------ | ------------------------------------------------------------------------------------------------ | ------------------------------------------------------ | | Create shield information barrier segment member | Adds a Box user to a shield information barrier segment for compliance and information security. | `BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER` | | Update group membership | Updates a user's group membership. | `BOX_UPDATE_GROUP_MEMBERSHIP` | | Action | What it does | Slug | | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | Assign legal hold policy | Assign a legal hold policy to a file, file version, folder, or user. | `BOX_ASSIGN_LEGAL_HOLD_POLICY` | | Assign retention policy | Assigns a retention policy to an item in Box to enforce content retention. | `BOX_ASSIGN_RETENTION_POLICY` | | Assign storage policy | Creates a storage policy assignment for an enterprise or user. | `BOX_ASSIGN_STORAGE_POLICY` | | Create legal hold policy | Create a new legal hold policy in Box. | `BOX_CREATE_LEGAL_HOLD_POLICY` | | Create metadata cascade policy | Creates a new metadata cascade policy that automatically applies a metadata template to all files and subfolders within a specified folder. | `BOX_CREATE_METADATA_CASCADE_POLICY` | | Create retention policy | Creates a retention policy for managing content lifecycle in Box. | `BOX_CREATE_RETENTION_POLICY` | | Force apply metadata cascade policy to folder | Forces a metadata cascade policy to immediately apply the folder's metadata template to all existing child files and subfolders. | `BOX_FORCE_APPLY_METADATA_CASCADE_POLICY_TO_FOLDER` | | Update legal hold policy | Update an existing legal hold policy in Box. | `BOX_UPDATE_LEGAL_HOLD_POLICY` | | Update retention policy | Updates an existing Box retention policy. | `BOX_UPDATE_RETENTION_POLICY` | | Update storage policy assignment | Updates a storage policy assignment for an enterprise or user. | `BOX_UPDATE_STORAGE_POLICY_ASSIGNMENT` | | Action | What it does | Slug | | ------------------------- | ------------------------------ | ------------------------------- | | Add or update user avatar | Adds or updates a user avatar. | `BOX_ADD_OR_UPDATE_USER_AVATAR` | | Action | What it does | Slug | | ---------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------- | | Create shield information barrier report | Creates a shield information barrier report for a given barrier. | `BOX_CREATE_SHIELD_INFORMATION_BARRIER_REPORT` | | Action | What it does | Slug | | ----------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------- | | Create shield information barrier segment | Creates a new shield information barrier segment for compliance and information isolation. | `BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT` | | Create shield information barrier segment restriction | Creates a ONE-WAY shield information barrier segment restriction preventing collaboration between members of two segments (e.g., Investment Banking cannot collaborate with Research). | `BOX_CREATE_SHIELD_INFORMATION_BARRIER_SEGMENT_RESTRICTION` | | Update barrier segment | Updates a shield information barrier segment's name and/or description. | `BOX_UPDATE_BARRIER_SEGMENT` | | Action | What it does | Slug | | ----------------------- | ------------------------------------------------------------------- | ----------------------------- | | Create terms of service | Creates a terms of service for a given enterprise and type of user. | `BOX_CREATE_TERMS_OF_SERVICE` | | Update terms of service | Updates an existing terms of service for the enterprise. | `BOX_UPDATE_TERMS_OF_SERVICE` | | Action | What it does | Slug | | --------------------------------------- | ----------------------------------------------------------------------------------------------- | --------------------------------------------- | | Commit upload session | Commits an upload session and creates a file from the uploaded chunks. | `BOX_COMMIT_UPLOAD_SESSION` | | Create upload session | Creates an upload session for chunked upload of large files (20MB+). | `BOX_CREATE_UPLOAD_SESSION` | | Create upload session for existing file | Creates an upload session for uploading a new version of an existing file using chunked upload. | `BOX_CREATE_UPLOAD_SESSION_FOR_EXISTING_FILE` | | Delete upload session | Abort and permanently remove a chunked upload session, discarding all uploaded data. | `BOX_DELETE_UPLOAD_SESSION` | | Action | What it does | Slug | | ------------------------------ | ------------------------------------------------------------------------------- | ------------------------------------ | | Add shared link to file | Adds a shared link to a file. | `BOX_ADD_SHARED_LINK_TO_FILE` | | Add shared link to folder | Adds a shared link to a folder, allowing it to be shared with others via a URL. | `BOX_ADD_SHARED_LINK_TO_FOLDER` | | Add shared link to web link | Adds a shared link to a web link. | `BOX_ADD_SHARED_LINK_TO_WEB_LINK` | | Delete shared link from file | Removes a shared link from a file in Box. | `BOX_DELETE_SHARED_LINK_FROM_FILE` | | Delete shared link from folder | Removes a shared link from a folder in Box. | `BOX_DELETE_SHARED_LINK_FROM_FOLDER` | | Update shared link on file | Updates a shared link on a file. | `BOX_UPDATE_SHARED_LINK_ON_FILE` | | Update shared link on folder | Updates a shared link on a folder. | `BOX_UPDATE_SHARED_LINK_ON_FOLDER` | | Update shared link on web link | Updates a shared link on a web link. | `BOX_UPDATE_SHARED_LINK_ON_WEB_LINK` | | Action | What it does | Slug | | ---------------------- | ----------------------------------------------------------------------------- | ---------------------------- | | Assign task | Assigns a task to a user. | `BOX_ASSIGN_TASK` | | Create task | Creates a single task on a file. | `BOX_CREATE_TASK` | | Delete task | Permanently deletes a task from Box. | `BOX_DELETE_TASK` | | Delete task assignment | Deletes a specific task assignment, removing the task from the assigned user. | `BOX_DELETE_TASK_ASSIGNMENT` | | Update task | Updates a task. | `BOX_UPDATE_TASK` | | Update task assignment | Updates a task assignment to change its resolution state or add a message. | `BOX_UPDATE_TASK_ASSIGNMENT` | | Action | What it does | Slug | | ------------------------------- | ---------------------------------------------------------------- | ------------------------------------- | | Append metadata taxonomy level | Appends a new level to a metadata taxonomy structure. | `BOX_APPEND_METADATA_TAXONOMY_LEVEL` | | Create metadata taxonomy | Create a new metadata taxonomy in Box. | `BOX_CREATE_METADATA_TAXONOMY` | | Create metadata taxonomy levels | Creates new hierarchical levels for a metadata taxonomy in Box. | `BOX_CREATE_METADATA_TAXONOMY_LEVELS` | | Create metadata taxonomy node | Create a new metadata taxonomy node within a specified taxonomy. | `BOX_CREATE_METADATA_TAXONOMY_NODE` | | Update metadata taxonomy | Update an existing metadata taxonomy's display name. | `BOX_UPDATE_METADATA_TAXONOMY` | | Update metadata taxonomy node | Update an existing metadata taxonomy node's display name. | `BOX_UPDATE_METADATA_TAXONOMY_NODE` | | Action | What it does | Slug | | ------------------------ | ------------------------------------------------------------------------- | ------------------------------ | | Create metadata template | Creates a new metadata template that can be applied to files and folders. | `BOX_CREATE_METADATA_TEMPLATE` | | Update metadata template | Updates a metadata template by applying JSON-Patch operations. | `BOX_UPDATE_METADATA_TEMPLATE` | | Action | What it does | Slug | | -------------------- | ------------------------------------------------------------------------------------------------------------------------ | -------------------------- | | Refresh access token | Refresh an Access Token using its client ID, secret, and refresh token. | `BOX_REFRESH_ACCESS_TOKEN` | | Request access token | Request an Access Token using either a client-side obtained OAuth 2.0 authorization code or a server-side JWT assertion. | `BOX_REQUEST_ACCESS_TOKEN` | | Action | What it does | Slug | | ------------------------------------------------ | ---------------------------------------------------------------------------------------------------------- | ------------------------------------------------------ | | Add user to group | Creates a group membership. | `BOX_ADD_USER_TO_GROUP` | | Create terms of service status for new user | Creates a terms of service status record for a user who has not previously accepted or rejected the terms. | `BOX_CREATE_TERMS_OF_SERVICE_STATUS_FOR_NEW_USER` | | Create user | Creates a new managed user in an enterprise. | `BOX_CREATE_USER` | | Update terms of service status for existing user | Updates the acceptance status of a terms of service for a user who has previously accepted or rejected it. | `BOX_UPDATE_TERMS_OF_SERVICE_STATUS_FOR_EXISTING_USER` | | Update user | Updates a managed or app user in an enterprise. | `BOX_UPDATE_USER` | | Action | What it does | Slug | | -------------------- | --------------------------------------------------------------------- | -------------------------- | | Delete file version | Move a file version to the trash. | `BOX_DELETE_FILE_VERSION` | | Promote file version | Promote a specific version of a file. | `BOX_PROMOTE_FILE_VERSION` | | Restore file version | Restores a specific version of a file after it was deleted (trashed). | `BOX_RESTORE_FILE_VERSION` | | Upload file version | Update a file's content. | `BOX_UPLOAD_FILE_VERSION` | | Action | What it does | Slug | | -------------- | ------------------------------------------------------------------ | -------------------- | | Create webhook | Creates a webhook to monitor a file or folder for specific events. | `BOX_CREATE_WEBHOOK` | | Update webhook | Updates an existing webhook's configuration. | `BOX_UPDATE_WEBHOOK` | | Action | What it does | Slug | | -------------- | ---------------------------------------------------------------------- | -------------------- | | Start workflow | Starts a Box Relay workflow with trigger type WORKFLOW\_MANUAL\_START. | `BOX_START_WORKFLOW` | | Action | What it does | Slug | | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------- | | Add initial classifications | Initializes the classification template for an enterprise with an initial set of classification options. | `BOX_ADD_INITIAL_CLASSIFICATIONS` | | Create box sign request | Creates a Box Sign request to send documents for electronic signing. | `BOX_CREATE_BOX_SIGN_REQUEST` | | Create collab exemption | Exempts a specific user from the enterprise's collaboration domain restrictions. | `BOX_CREATE_COLLAB_EXEMPTION` | | Create shield information barrier | Creates a shield information barrier to establish an "ethical wall" that separates individuals/groups within an enterprise and prevents confidential information sharing. | `BOX_CREATE_SHIELD_INFORMATION_BARRIER` | | Create ZIP download | Creates a request to download multiple files and folders as a single zip archive file. | `BOX_CREATE_ZIP_DOWNLOAD` | | Resend box sign request | Resends signature request emails to all outstanding signers. | `BOX_RESEND_BOX_SIGN_REQUEST` | Agents can use 286 of the 286 Box actions at this level: everything in **Read + write**, plus: * Delete policies * Stop sessions * Delete users * Delete agents * Delete cards * Delete collaborators * Delete domains * Delete groups * Delete members * Delete profiles * Delete segments * Delete taxonomies The 39 actions that this level adds to **Read + write**: | Action | What it does | Slug | | --------------- | --------------------------------------------------------- | --------------------- | | Delete AI agent | Permanently deletes a custom AI agent from Box AI Studio. | `BOX_DELETE_AI_AGENT` | | Action | What it does | Slug | | -------------------------------- | -------------------------------------------------- | -------------------------------------- | | Delete box skill cards from file | Removes any Box Skills cards metadata from a file. | `BOX_DELETE_BOX_SKILL_CARDS_FROM_FILE` | | Action | What it does | Slug | | -------------------- | ---------------------------------------------------------------------------------- | -------------------------- | | Delete collaboration | Removes a collaboration from a file or folder, revoking the collaborator's access. | `BOX_DELETE_COLLABORATION` | | Action | What it does | Slug | | ----------------------------------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------- | | Delete allowed collaboration domain | Removes a domain from the list of allowed collaboration domains (whitelist) within your enterprise. | `BOX_DELETE_ALLOWED_COLLABORATION_DOMAIN` | | Delete user domain exemption | Removes a user's exemption from the enterprise's collaboration domain restrictions. | `BOX_DELETE_USER_DOMAIN_EXEMPTION` | | Action | What it does | Slug | | ------------------ | ----------------------------------- | ------------------------ | | Delete email alias | Removes an email alias from a user. | `BOX_DELETE_EMAIL_ALIAS` | | Action | What it does | Slug | | -------------------------- | ------------------------------------------ | -------------------------------- | | Delete file permanently | Permanently deletes a file from the trash. | `BOX_DELETE_FILE_PERMANENTLY` | | Delete watermark from file | Removes the watermark from a file. | `BOX_DELETE_WATERMARK_FROM_FILE` | | Action | What it does | Slug | | ---------------------------- | ----------------------------------------------------------------------------------- | ---------------------------------- | | Delete folder permanently | Permanently deletes a folder that is in the trash. | `BOX_DELETE_FOLDER_PERMANENTLY` | | Delete watermark from folder | Removes the watermark from a folder. | `BOX_DELETE_WATERMARK_FROM_FOLDER` | | Transfer owned folders | Transfers all files and folders owned by one user to another user's account in Box. | `BOX_TRANSFER_OWNED_FOLDERS` | | Action | What it does | Slug | | ------------ | ---------------------------- | ------------------ | | Delete group | Permanently deletes a group. | `BOX_DELETE_GROUP` | | Action | What it does | Slug | | -------------------------------- | ----------------------------------------------------------------------------------------- | -------------------------------------- | | Delete Slack integration mapping | Deletes a Slack integration mapping that links a Box folder to a Slack channel. | `BOX_DELETE_SLACK_INTEGRATION_MAPPING` | | Delete teams integration mapping | Deletes a Microsoft Teams integration mapping that links a Box folder to a Teams channel. | `BOX_DELETE_TEAMS_INTEGRATION_MAPPING` | | Action | What it does | Slug | | --------------------------- | ---------------------------------------------------- | --------------------------------- | | Delete web link permanently | Permanently deletes a web link that is in the trash. | `BOX_DELETE_WEB_LINK_PERMANENTLY` | | Action | What it does | Slug | | ------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------------ | | Delete shield information barrier segment member by ID | Removes a user from a shield information barrier segment by deleting their membership. | `BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT_MEMBER_BY_ID` | | Action | What it does | Slug | | ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------- | | Delete legal hold policy | Permanently delete an existing legal hold policy from Box. | `BOX_DELETE_LEGAL_HOLD_POLICY` | | Delete metadata cascade policy | Permanently deletes a metadata cascade policy from a folder. | `BOX_DELETE_METADATA_CASCADE_POLICY` | | Delete retention policy | Permanently deletes a retention policy from the Box enterprise. | `BOX_DELETE_RETENTION_POLICY` | | Delete retention policy assignment | Removes a retention policy assignment from content in Box. | `BOX_DELETE_RETENTION_POLICY_ASSIGNMENT` | | Delete storage policy assignment | Deletes a storage policy assignment, causing the assigned user to inherit the enterprise's default storage policy (Box Zone). | `BOX_DELETE_STORAGE_POLICY_ASSIGNMENT` | | Unassign legal hold policy | Remove a legal hold policy assignment from an item (user, folder, file, or file version). | `BOX_UNASSIGN_LEGAL_HOLD_POLICY` | | Action | What it does | Slug | | ------------------ | ---------------------------------------------- | ------------------------ | | Delete user avatar | Deletes a user's custom avatar image from Box. | `BOX_DELETE_USER_AVATAR` | | Action | What it does | Slug | | ----------------------------------------- | ------------------------------------------------------------------- | ----------------------------------------------- | | Delete shield information barrier segment | Permanently deletes a shield information barrier segment by its ID. | `BOX_DELETE_SHIELD_INFORMATION_BARRIER_SEGMENT` | | Action | What it does | Slug | | ----------------------------- | ------------------------------------------------------------------------------------------ | ----------------------------------- | | Terminate user group sessions | Terminates all active sessions for users belonging to the specified Box enterprise groups. | `BOX_TERMINATE_USER_GROUP_SESSIONS` | | Terminate user sessions | Creates asynchronous jobs to terminate active Box sessions for specified users. | `BOX_TERMINATE_USER_SESSIONS` | | Action | What it does | Slug | | -------------------------------- | --------------------------------------------- | -------------------------------------- | | Delete shared link from web link | Removes a shared link from a web link in Box. | `BOX_DELETE_SHARED_LINK_FROM_WEB_LINK` | | Action | What it does | Slug | | ----------------------------- | --------------------------------------------------------------- | ----------------------------------- | | Delete metadata taxonomy | Permanently deletes a metadata taxonomy from the enterprise. | `BOX_DELETE_METADATA_TAXONOMY` | | Delete metadata taxonomy node | Permanently deletes a metadata taxonomy node from Box. | `BOX_DELETE_METADATA_TAXONOMY_NODE` | | Trim metadata taxonomy levels | Deletes the last level from a metadata taxonomy by trimming it. | `BOX_TRIM_METADATA_TAXONOMY_LEVELS` | | Action | What it does | Slug | | ------------------------ | ------------------------------------------------------------------------------------ | ------------------------------ | | Delete metadata template | Permanently delete a metadata template and all its instances from files and folders. | `BOX_DELETE_METADATA_TEMPLATE` | | Action | What it does | Slug | | ------------------- | ----------------------------------------------------------------------------------------------------- | ------------------------- | | Revoke access token | Revoke an active Access Token, effectively logging a user out that has been previously authenticated. | `BOX_REVOKE_ACCESS_TOKEN` | | Action | What it does | Slug | | ---------------------- | ----------------------------------------------- | ---------------------------- | | Delete user | Permanently deletes a user from the enterprise. | `BOX_DELETE_USER` | | Delete user from group | Deletes a specific group membership. | `BOX_DELETE_USER_FROM_GROUP` | | Action | What it does | Slug | | -------------- | --------------------------------------------------- | -------------------- | | Delete webhook | Permanently deletes a webhook from the Box account. | `BOX_DELETE_WEBHOOK` | | Action | What it does | Slug | | ---------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------- | | Cancel box sign request | Cancels a pending Box Sign request that has not yet been fully signed or declined. | `BOX_CANCEL_BOX_SIGN_REQUEST` | | Delete barrier restriction | Deletes a shield information barrier segment restriction by its unique ID. | `BOX_DELETE_BARRIER_RESTRICTION` | | Delete device pin | Deletes an individual device pin from the enterprise. | `BOX_DELETE_DEVICE_PIN` | | Update shield information barrier status | Change the status of a shield information barrier. | `BOX_UPDATE_SHIELD_INFORMATION_BARRIER_STATUS` | ## Connect Box Before you start: * You need a Box account that you can sign in to. * Your Squad subscription must be active. Squad does not connect apps while the subscription is not active. Open **Settings** > **Integrations**. On the **Connected apps** tab, click **+ Add integration**. Find **Box** in the catalog and click it. You can type the name in **Search the catalog…**. Under **Default scope**, choose an access level. This level applies to every agent. Click **Connect Box**. The Box sign-in page opens in a new tab. Sign in to Box and approve the request. Check that it works: Box shows under **YOUR CONNECTIONS**, with a row for the account and its access level. ## Change the access level 1. Under **YOUR CONNECTIONS**, find the Box account. 2. Open the account menu (⋯) and click **Manage scope**. 3. Under **Default scope**, choose the new level. 4. Click **Save access**. The change does not need a new sign-in. Agents get the new level from their next call. ## Set access for one agent Every agent uses the account's level unless you set something else for it. You can narrow one agent to a lower level, or block it. 1. Under **YOUR CONNECTIONS**, open the account menu (⋯) on the Box account. 2. Click **Manage scope**. 3. Under **Per-agent access**, find the agent. 4. Choose the **Default** option to follow the account's level, choose a lower level, or choose **No access**. 5. Click **Save access**. An agent never gets more than the account's level, even if you choose a higher level for it. Changes apply from the agent's next call. An agent with **No access** does not see the account. ## Use more than one Box account Click **+ Account** on the Box card to connect another account. Agents use the primary account unless they are asked to use a specific one. * After you click **+ Account**, follow the connect steps above. * Each account has its own access level. * The first account you connect becomes the primary account. It shows **★ PRIMARY**. * To change the primary account, open the account menu (⋯) and click **Make primary**. * To tell accounts apart, open the account menu (⋯) and click **Rename**. ## Reconnect or disconnect Reconnect when the connection has expired, or when you need to change what the account can reach on the Box side: 1. Open the account menu (⋯) and click **Reconnect**. 2. Click **Reauthorize on Box**. 3. Sign in to Box and approve the request. Reconnect signs in to the same account again. It does not add a second connection. Open the account menu (⋯) on the Box account and click **Disconnect**. Agents lose access to that account at once. **Disconnect** acts at once, with no confirmation step. If it was the primary account, another connected Box account becomes primary. ## Costs Box actions do not use Squad credits. Connected apps never use credits. For what does use credits, see [What Squad costs](/docs/costs). ## Troubleshooting An agent reports that an action is not allowed on this account. * Cause: the action is outside the account's access level, or outside the level you set for that agent. * Fix: choose a higher level in **Manage scope**, or change the agent's row under **Per-agent access**. An agent says it has no access to Box, or it does not see the account. * Cause: the agent is set to **No access** under **Per-agent access**, or the account is not connected. * Fix: open **Manage scope** and change the agent's row. If the account is missing, connect it again. Connecting or saving fails with "Your subscription isn't active." * Cause: your Squad subscription is not active. * Fix: resubscribe. See [Manage your subscription](/docs/billing). An agent says the Box connection has expired. * Cause: the sign-in for that account is no longer valid. * Fix: use **Reconnect** on the account. ## Common questions Each Box account has an access level: **Read-only**, **Read + write**, and **Admin**. Squad refuses any agent action outside that level. You can also narrow or block single agents under **Per-agent access**. Click **+ Account** on the Box card to connect another account. Agents use the primary account unless they are asked to use a specific one. Open the account menu (⋯) on the Box account and click **Disconnect**. Agents lose access to that account at once. ## Related pages Use this when an action you need is not in this app.