Skip to main content

Authorization

Follow this guide to create a new Confluence credential that will allow Nexla to authenticate to and exchange data with your Confluence account.
confluence_api_auth.png

Confluence

Prerequisites​

Before creating a Confluence credential, you need to obtain authentication credentials from your Confluence account. Confluence uses Basic Authentication with an Atlassian account username and API token combination to authenticate API requests.

To use Confluence with Nexla, you need:

  • Access to your Confluence account
  • A Confluence account with appropriate permissions to access the resources you want to work with
  • Your Atlassian account username for Basic Authentication
  • Your API token for Basic Authentication (not your password)
  • Your Confluence domain

The Confluence API requires your domain, which is the base domain of your Confluence instance (e.g., your-domain.atlassian.net). The API token is different from your password and must be generated from your Atlassian account settings. For detailed information about Confluence authentication, API token setup, and available resources, refer to the Confluence API documentation.

Create a Confluence Credential​

  • To create a new Confluence credential, after selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

New Credential Overlay – Confluence

ConfluenceCred.png

Credential Name & Description​

  1. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

    Resource descriptions are recommended but are not required. They should be used provide information about the resource purpose, data freshness, etc. that can help the owner and other users efficiently understand and utilize the resource.

Basic Authentication Configuration​

  1. Enter your Atlassian account username in the Atlassian account username field. This is the username associated with your Atlassian account that will be used for Basic Authentication.

  2. Enter your Confluence API token in the API token field. This is the API token you generated from your Atlassian account settings. The API token is used together with your username for Basic Authentication. Note: The API token is different from your password and must be generated from your Atlassian account settings.

  3. Enter your Confluence domain in the Domain field. This should be the base domain of your Confluence instance (e.g., your-domain.atlassian.net) without the protocol (https://) or path. The domain is used to construct the complete API endpoint URLs for all API requests.

    Keep your authentication credentials secure and do not share them publicly. The credentials provide access to your Confluence account and should be treated as sensitive information. Basic Authentication credentials are sent in the Authorization header for all API requests to the Confluence API. The API token is different from your password and must be generated from your Atlassian account settings. The domain determines which Confluence instance your credential will access. For detailed information about obtaining and managing API tokens, see the Confluence API documentation.

Save the Credential​

  1. Once all of the relevant steps in the above sections have been completed, click the Save button at the bottom of the overlay to save the configured credential.

  2. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation and can be selected for use with a new data source or destination.