permissions_data
field, which is within the
data_source
field under the element’s metadata
field. This information lists the users or groups, if any, that have
permissions to read, update, or delete the element’s associated source document.
The following example shows what the output looks like. Ellipses indicate content that has been omitted from this example for brevity.
CONFLUENCE_URL
- The target Confluence site’s URL, represented by --url
(CLI) or url
(Python).
CONFLUENCE_USERNAME
and CONFLUENCE_API_TOKEN
- The name or email address, and API token of the target Confluence user, represented by --username
(CLI) or username
(Python) and --api-token
(CLI) or api-token
(Python), respectively.CONFLUENCE_PERSONAL_ACCESS_TOKEN
- The PAT for the target Confluence user, represented by --token
(CLI) or token
(Python).CONFLUENCE_USERNAME
and CONFLUENCE_PASSWORD
- The name or email address, and password of the target Confluence user, represented by --username
(CLI) or username
(Python) and --password
(CLI) or password
(Python), respectively.--spaces
(CLI) or spaces
(Python): Optionally, the list of the names of the specific spaces to access, expressed as a comma-separated list of strings (CLI) or an array of strings (Python), with each string representing a space’s name. The default is no specific spaces, if not otherwise specified.--max-num-of-spaces
(CLI) or max_num_of_spaces
(Python): Optionally, the maximum number of spaces to access, expressed as an integer. The default value is 500
if not otherwise specified.--max-num-of-docs-from-each-space
(CLI) or max_num_of_docs_from_each_space
(Python): Optionally, the maximum number of documents to access from each space, expressed as an integer. The default value is 100
if not otherwise specified.--cloud
or --no-cloud
(CLI) or cloud
(Python): Optionally, whether to use Confluence Cloud (--cloud
for CLI or cloud=True
for Python). The default is --no-cloud
(CLI) or cloud=False
(Python) if not otherwise specified.--extract-images
(CLI) or extract_images
(Python): Optionally, download images and replace the HTML content with Base64-encoded images. The default is --no-extract-images
(CLI) or extract_images=False
(Python) if not otherwise specified.--extract-files
(CLI) or extract_files
(Python): Optionally, download any embedded files. The default is --no-extract-files
(CLI) or extract_files=False
(Python) if not otherwise specified.--force-download
(CLI) or force_download
(Python): Optionally, re-download extracted files even if they already exist locally. The default is --no-force-download
(CLI) or force_download=False
(Python) if not otherwise specified.--allow-list
(CLI) or allow_list
: Optionally, a command-separated list (CLI) or a an array of strings (Python) of allowed URLs to download. By default, the base URL that the original HTML came from is used, if not otherwise specified.--partition-by-api
option (CLI) or partition_by_api
(Python) parameter to specify where files are processed:
--partition-by-api
(CLI) or partition_by_api
(Python), or explicitly specify partition_by_api=False
(Python).
Local file processing does not use an Unstructured API key or API URL, so you can also omit the following, if they appear:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
--partition-by-api
(CLI) or partition_by_api=True
(Python).
Unstructured also requires an Unstructured API key and API URL, by adding the following:
--api-key $UNSTRUCTURED_API_KEY
(CLI) or api_key=os.getenv("UNSTRUCTURED_API_KEY")
(Python)--partition-endpoint $UNSTRUCTURED_API_URL
(CLI) or partition_endpoint=os.getenv("UNSTRUCTURED_API_URL")
(Python)UNSTRUCTURED_API_KEY
and UNSTRUCTURED_API_URL
, representing your API key and API URL, respectively.https://api.unstructuredapp.io/general/v0/general
, which is the API URL for the Unstructured Partition Endpoint. However, you should always use the URL that was provided to you when your Unstructured account was created. If you do not have this URL, contact Unstructured Sales at sales@unstructured.io.If you do not have an API key, get one now.If the Unstructured API is self-hosted, the process
for generating Unstructured API keys, and the Unstructured API URL that you use, are different.
For details, contact Unstructured Sales at
sales@unstructured.io.