Confluence account details

To establish a connection to Confluence, you must add an account that defines the account details to connect with. You can define these details by creating a configuration object in the App Connect Dashboard, the Red Hat® OpenShift® web console or CLI, or the Kubernetes CLI.

Account parameters

App Connect supports cloud-hosted and on-premises deployments of Confluence.

You can define one or more accounts for Confluence.

For each account that you require, you can specify a new set of account details in any of the following ways:

  • If you are using the App Connect Dashboard, either complete the Account details fields in the Create configuration panel, or specify the account parameters in an accounts.yaml file before importing it into the Create configuration panel. For more information, see Accounts type.
  • If you are using the Red Hat OpenShift web console or CLI, or the Kubernetes CLI, specify the account parameters in an accounts.yaml file, and then use this configuration file to create a configuration object. For more information, see Creating the file for a configuration object of type Accounts.

The set of required and optional Account fields or parameters are listed in the following table.

For information about locating the values for these account parameters, see Locating the values for the account parameters.

Field Parameter Values Condition Description

Account name

name

User defined

Required

The name of a Confluence account that is used in the exported flow.

User name

username

User defined

Required

Confluence cloud instance: The username (email address) that you use to log in to your Confluence cloud instance.

Confluence on-premises instance: The username that you use to log in to your Confluence on-premises instance.

Password or API token

password

User defined

Required

Confluence cloud instance: The API token that you use to log in to your Confluence cloud instance.

Confluence on-premises instance: The password that you use to log in to your Confluence on-premises instance.

REST API URI

onPremiseUri

User defined

Required only if connecting to a Confluence on-premises instance.
The REST API URI for an on-premises instance:
  • For an on-premises setup that is customized to deploy with context, specify the API URI as /<contextName>/rest/api.
  • For a setup without context, specify the API URI as /rest/api.

Endpoint URL

endpointUrl

User defined

Required

The Confluence server URL.

Locating the values for the account parameters

If you are using a cloud-hosted deployment of Confluence, specify the value for the password parameter as an API token that can be used to perform basic authentication. You can create an API token from your Atlassian account as follows:

  1. Go to https://id.atlassian.com/manage/api-tokens and log in to your Atlassian account.
  2. Click Create API token.
    Create API token
  3. Specify a short and meaningful label for your API token and then click Create.
    mm
  4. Before you close the panel, click Copy and then save the API token to a secure location for future use. Set this API token as the value for the password parameter.

Examples

Remember: An accounts.yaml file that defines one or more accounts must always begin with the following line:
accounts:

Example 1 (Cloud):
  confluence:
    - name: Account 1
      credentials:
        username: janedoe@email.com
        password: A3FrEDDYjlp07TREyuiuuo5678YTRM
      endpoint:
        endpointUrl: 'https://mydomain.atlassian.net'
Example 2 (On premises):
  confluence:
    - name: Account 1
      credentials:
        username: admin
        password: topsecret1234
        onPremiseUri: /rest/api
      endpoint:
        endpointUrl: 'http://192.0.2.0:8090/'