Confluence

Ingest your files into Unstructured from Confluence.

The requirements are as follows.

• A Confluence Cloud account or Confluence Data Center installation.

• The site URL for your Confluence Cloud account or Confluence Data Center installation.

• A user in your Confluence Cloud account or Confluence Data Center installation.

• The user must have the correct permissions in your Conflunce Cloud account or Confluence Data Center installation to access the target spaces and pages.

• One of the following:

  • For Confluence Cloud or Confluence Data Center, the target user’s name or email address, and password. Change a Confluence Cloud user’s password. Change a Confluence Data Center user’s password.
  • For Confluence Cloud only, the target user’s name or email address, and API token. Create an API token.
  • For Confluence Data Center only, the target user’s personal access token (PAT). Create a PAT.

• Optionally, the names of the specific spaces in the Confluence instance to access.

The following video provides related setup information for Confluence Cloud:

To create or change a Confluence source connector, see the following examples.

# ...
from unstructured_client.models.shared import <Create|Update>SourceConnector
# ...
source_connector = <Create|Update>SourceConnector(
    name="<name>", # Create only.
    type="confluence", # Create only.
    config={
        "url": "<url>",
        "max_num_of_spaces": <max-num-of-spaces>,
        "max_num_of_docs_from_each_space": <max-num-of-docs-from-each-space>,
        "spaces": ["<space-name>", "<space-name>"],

        # For API token authentication:

        "username": "<username>",
        "token": "<api-token>",
        "cloud": "<true|false>"

        # For personal access token (PAT) authentication:

        "token": "<personal-access-token>",
        "cloud": "false"

        # For password authentication:

        "username": "<username>",
        "password": "<password>",
        "cloud": "<true|false>"     
    }
)

Replace the preceding placeholders as follows:

• <name> (required) - A unique name for this connector.
• <url> (required) - The URL to the target Confluence Cloud instance.
• <max-num-of-spaces> - The maximum number of Confluence spaces to access within the Confluence Cloud instance. The default is 500 unless otherwise specified.
• <max-num-of-docs-from-each-space> - The maximum number of documents to access within each space. The default is 150 unless otherwise specified.
• spaces is an array of strings, with each <space-name> specifying the name of a space to access, for example: ["luke","paul"]. By default, if no space names are specified, and the <max-num-of-spaces> is exceeded for the instance, be aware that you might get unexpected results.

For API token authentication:

• <username> - The name or email address of the target user.
• <api-token> - The user’s API token value.
• For cloud, true if you are using Confluence Cloud. The default is false if not otherwise specified.

For personal access token (PAT) authentication:

• <personal-access-token> - The target user’s PAT value.
• cloud should always be false.

For password authentication:

• <username> - The name or email address of the target user.
• <password> - The user’s password.
• For cloud, true if you are using Confluence Cloud. The default is false if not otherwise specified.

To change a connector, replace <connector-id> with the source connector’s unique ID. To get this ID, see List source connectors.