Set up a Confluence v2 connector
This is an updated and improved version of the Confluence connector! If you’re setting up Confluence with ConductorOne for the first time, you’re in the right place.
Capabilities
Resource | Sync | Provision |
---|---|---|
Accounts | ✅ | |
Groups | ✅ | |
Spaces | ✅ | |
Space permissions | ✅ |
Available hosting methods
Choose the hosting method that best suits your needs:
Method | Availability | Notes |
---|---|---|
Cloud hosted | ✅ | A built-in, no-code connector hosted by ConductorOne. |
Self-hosted | ✅ | The Confluence connector, hosted and run in your own environment. |
Gather Confluence credentials
Each setup method requires you to pass in credentials generated in Confluence. Gather these credentials before you move on.
A user with Administrator access in Confluence must perform this task.
Create an API token
Log into your Confluence account with Administrator access.
Navigate to https://id.atlassian.com/manage-profile/security/api-tokens.
Click Create API token.
Give your token a label, such as ConductorOne, and click Create.
Carefully copy and save the newly generated API token.
That’s it! Next, move on to the instructions for your chosen setup method.
Set up a Confluence cloud-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of Confluence credentials generated by following the instructions above
In ConductorOne, click Connectors > Add connector.
Search for Confluence v2 and click Add.
Choose how to set up the new Confluence connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
Find the Settings area of the page and click Edit.
Enter your Confluence domain (the URL of your Confluence instance is
<YOUR DOMAIN>.atlassian.net
) into the Confluence site domain field.Enter the username for your Confluence account in the Username field.
Paste the API token into the API key field.
Optional. If want to sync information on Confluence users’ personal spaces and their permissions, uncheck the Skip syncing personal spaces and their permissions box.
Click Save.
The connector’s label changes to Syncing, followed by Connected. You can view the logs to ensure that information is syncing.
That’s it! Your Confluence connector is now pulling access data into ConductorOne.
Set up a Confluence cloud-hosted connector using Terraform
As an alternative to the cloud-hosted integration process described above, you can use Terraform to configure the integration between Confluence and ConductorOne.
See the ConductorOne Confluence v2 integration resource page in the ConductorOne Terraform registry for example usage and the full list of required and optional parameters.
Set up a Confluence self-hosted connector
To complete this task, you’ll need:
- The Connector Administrator or Super Administrator role in ConductorOne
- Access to the set of Confluence credentials generated by following the instructions above
When running in service mode on Kubernetes, a self-hosted connector maintains an ongoing connection with ConductorOne, automatically syncing and uploading data at regular intervals. This data is immediately available in the ConductorOne UI for access reviews and access requests.
Why use Kubernetes? Kubernetes provides automated deployment, scaling, and management of your connectors. It ensures high availability and reliable operation of your connector services.
Step 1: Configure the Confluence connector
In ConductorOne, navigate to Connectors > Add connector.
Search for Baton and click Add.
Choose how to set up the new Confluence connector:
Add the connector to a currently unmanaged app (select from the list of apps that were discovered in your identity, SSO, or federation provider that aren’t yet managed with ConductorOne)
Add the connector to a managed app (select from the list of existing managed apps)
Create a new managed app
Set the owner for this connector. You can manage the connector yourself, or choose someone else from the list of ConductorOne users. Setting multiple owners is allowed.
If you choose someone else, ConductorOne will notify the new connector owner by email that their help is needed to complete the setup process.
Click Next.
In the Settings area of the page, click Edit.
Click Rotate to generate a new Client ID and Secret.
Carefully copy and save these credentials. We’ll use them in Step 2.
Step 2: Create Kubernetes configuration files
Create two Kubernetes manifest files for your Confluence connector deployment:
Secrets configuration
# baton-confluence-secrets.yaml
apiVersion: v1
kind: Secret
metadata:
name: baton-confluence-secrets
type: Opaque
stringData:
# ConductorOne credentials
BATON_CLIENT_ID: <ConductorOne client ID>
BATON_CLIENT_SECRET: <ConductorOne client secret>
# Confluence credentials
BATON_API_KEY: <API key for your Confluence account>
BATON_DOMAIN_URL: <Domain of your Confluence instance>
BATON_USERNAME: <Username for your Confluence account>
See the connector’s README or run
--help
to see all available configuration flags and environment variables.
Deployment configuration
# baton-confluence.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
name: baton-confluence
labels:
app: baton-confluence
spec:
selector:
matchLabels:
app: baton-confluence
template:
metadata:
labels:
app: baton-confluence
baton: true
baton-app: confluence
spec:
containers:
- name: baton-confluence
image: ghcr.io/conductorone/baton-confluence:latest
args: ["service"]
imagePullPolicy: IfNotPresent
envFrom:
- secretRef:
name: baton-confluence-secrets
Step 3: Deploy the connector
Create a namespace in which to run ConductorOne connectors (if desired):
kubectl create namespace baton-confluence
Apply the secret configuration:
kubectl -n baton-confluence apply -f baton-confluence-secrets.yaml
Apply the deployment:
kubectl -n baton-confluence apply -f baton-confluence.yaml
Step 4: Verify the deployment
Check that the deployment is running:
kubectl -n c1 get pods
View the connector logs:
kubectl -n c1 logs -l app=baton-${baton-confluence}
Check that the connector data uploaded correctly. In ConductorOne, click Applications. On the Managed apps tab, locate and click the name of the application you added the Confluence connector to. Confluence data should be found on the Entitlements and Accounts tabs.
That’s it! Your Confluence connector is now pulling access data into ConductorOne.