list_box_files.py - List files from private Box folders

Description¶

Lists files from a private Box folder using JWT authentication and outputs results to a text file. Useful for creating inventories of restricted data stored in Box without downloading the files.

Usage¶

python tools/list_box_files.py SUBFOLDER [options]

Arguments¶

• SUBFOLDER (required) - Subfolder identifier, numeric part only (e.g., 1234 for aearep-1234)

• --box-folder-id - Box folder ID (default: from BOX_FOLDER_PRIVATE env var)

• --box-key-id - Box private key ID (default: from BOX_PRIVATE_KEY_ID env var)

• --box-enterprise-id - Box enterprise ID (default: from BOX_ENTERPRISE_ID env var)

• --output-file - Output file path (default: generated/manifest.restricted.txt)

• -v, --verbose - Enable verbose output

Example¶

python tools/list_box_files.py 1234 --output-file generated/box-files.txt

Requirements¶

• Python >= 3.9

• boxsdk: Box Python SDK with JWT support

• Valid Box JWT application credentials

Environment Variables¶

• BOX_FOLDER_PRIVATE - Box folder ID to list files from

• BOX_PRIVATE_KEY_ID - Box JWT public key ID

• BOX_ENTERPRISE_ID - Box enterprise ID

• BOX_CLIENT_ID - Box client ID (optional if using config file)

• BOX_CLIENT_SECRET - Box client secret (optional if using config file)

• BOX_CONFIG_PATH - Directory containing the Box config file

• BOX_PRIVATE_JSON - Base64 encoded content of the Box config JSON file

Output¶

Creates a text file listing all files in the specified Box folder, typically used for manifest generation.

See Also¶

• download_box_private.py - Download files from private Box folders