Box

​

Requirements

1. Access to the Developer Console from your Box enterprise account or Box developer account.
2. A Box Custom App in your Box account, set up to use Server Authentication (with JWT). See Setup with JWT.
3. The appropriate application scopes and advanced features set up for the Box Custom App, as follows:
   • In the Box Custom App, on the Configuration tab, under Application Scopes, check the box titled Write all files and folders stored in Box.
   • In the Box Custom App, on the Configuration tab, under Advanced Features, check the box titled Make API calls using the as-user header.
   • Click Save Changes before continuing.
4. Authorization by a Box Admin in your Box account for the Box Custom App. See App Authorization.
5. Access by your Box account’s source or target folder to your Box Custom App, as follows:
   • In the Box Custom App, on the General Settings tab, copy the Service Account ID (which takes the form AutomationUser_<your-app-service-id>_<a-random-string@boxdevedition.com).
   • Share your Box account’s target folder with the copied service account’s email address as a Co-owner or Editor.
   • Note the remote URL to the target folder, which takes the format box://<path/to/folder/in/account>.
6. The private key configuration JSON file for the Box Custom App, or a string that contains this file’s contents.
   • To download this file, in the Box Custom App, on the Configuration tab, under Add and Manage Public Keys, click Generate a Public/Private Keypair. Store the downloaded private key configuration JSON file in a secure location.
   • To ensure maximum compatibility across Unstructured service offerings, you should give the private key configuration JSON file information to Unstructured as a single-line string that contains the contents of the downloaded private key configuration JSON file (and not the file itself). To print this single-line string, suitable for copying, you can run one of the following commands from your Terminal or Command Prompt. In this command, replace <path-to-downloaded-key-file> with the path to the private key configuration JSON file that you downloaded by following the preceding instructions.
     • For macOS or Linux:
       tr -d '\n' < <path-to-downloaded-key-file>
       
     • For Windows:
       (Get-Content -Path "<path-to-downloaded-key-file>" -Raw).Replace("`r`n", "").Replace("`n", "")
       

​

Document permissions metadata

• If the same user or group appears at multiple levels with different roles, Unstructured chooses the least-restrictive role.
• Unstructured does not include the following in the permission metadata. No sentinel value is written into the permission metadata.
  • all_users_group: Box’s built-in group representing every user in the enterprise.
  • is_access_only: Collaboration property that determines whether, for collaborators, to display the items in the All Files list and let them see the path to the root folder for the shared item.
• Unstructured only includes collaborations with a status of accepted. It does not include collaborations with a status of pending or rejected.

• Unstructured excludes the uploader role because it confers no read, update, or delete access.
• Unstructured maps the Box editor role to read and update access but not delete, even though that role does allow deleting files.

​

Identifier format

• Get user
• Get group

​

Metadata output example

[
    {
        "...": "...",
        "metadata": {
            "...": "...",
            "data_source": {
                "...": "...",
                "permissions_data": [
                    {
                        "read": {
                            "users": ["11446688", "11336699"],
                            "groups": ["11223344"]
                        }
                    },
                    {
                        "update": {
                            "users": ["11446688"],
                            "groups": []
                        }
                    },
                    {
                        "delete": {
                            "users": [],
                            "groups": []
                        }
                    }
                ],
                "...": "..."
            }
        }
    }
]

​

Examples

import os

from unstructured_client import UnstructuredClient
from unstructured_client.models.operations import CreateSourceRequest
from unstructured_client.models.shared import CreateSourceConnector

with UnstructuredClient(api_key_auth=os.getenv("UNSTRUCTURED_API_KEY")) as client:
    response = client.sources.create_source(
        request=CreateSourceRequest(
            create_source_connector=CreateSourceConnector(
                name="<name>",
                type="box",
                config={
                    "remote_url": "<remote-url>",
                    "recursive": <True|False>,
                    "box_app_config": "<box-app-config>"
                }
            )
        )
    )

    print(response.source_connector_information)

​

Configuration settings

​

Learn more

•   Finding Needles in a Haystack: PII Detection at Scale with Unstructured, Box, and Elasticsearch