How to add Confluence to Dropbox Dash
This article describes a feature available to all Dropbox Dash customers.
Note: Dash can only support Confluence accounts with a single site. If you have multiple Confluence sites, Dash won’t correctly ingest your Confluence data.
Overview of setup
Step 1: Create an admin service account with an Org Admin role in Confluence.
Step 2: Add Confluence to Dash using one of the two supported authentication methods. Learn how to select the right method for your team.
- API key method
- OAuth method
How to create an admin service account in Confluence
To add Confluence to Dash, a Confluence admin must authenticate and authorize a company-level integration between Confluence and Dash. For better security and to prevent issues with the Confluence and Dash integration (like if an admin leaves), it's recommended to create a non-human admin service account in Confluence for this integration.
Notes:
- The recommended service account name is “svc-dropboxdash-atlassian-confluence”.
- Before creating a Confluence account for the service account used with Dash, make sure there’s an email address for “svc-dropboxdash-atlassian-confluence,” like “svc-dropboxdash-atlassian-confluence@company_domain_name.com.” This email will be used to log in and receive messages to complete the Dropbox account setup.
- Learn more about service account naming conventions and recommendations.
To create an admin service account in Confluence, you’ll need to:
- Invite a service account to Confluence.
- Complete this step if your service account isn't automatically added to your Confluence site. If it is added automatically, proceed to step 2.
- Add the Org Admin role to the service account.
How to invite a service account to Confluence
Notes:
- If the service account you created isn't automatically added to your Confluence site, follow these steps.
- These steps may differ slightly from what admins see in the Atlassian Administration view, depending on your version of Atlassian. Learn more about inviting users from Atlassian Administration.
- Log in to Atlassian Administration with your admin credentials.
- Click Directory.
- Click Invite users.
- Enter the email address for the service account user in the Invite by email address… field.
- Select the product access: Confluence Software
- Click Invite users.
- You’ll be returned to the Atlassian admin page for Users and should see “svc-dropboxdash-atlassian-confluence” as an invited user.
- Open the email account for the user “svc-dropboxdash-atlassian-confluence” and locate the invitation to Confluence.
- Click Accept Invite.
- In the pop-up window, enter “svc-dropboxdash-atlassian-confluence” in the Full name field.
- Enter a new password in the Password field.
- Note the password somewhere safe, such as your password management vault.
- Click Continue.
- You'll be asked to select a role that best describes your team's work. Select an option appropriate from the dropdown menu, then click Finish.
Note: The service account's access and control scope should be limited to Confluence. If you have multiple Atlassian products, you'll need to set the Product roles for those that aren't Confluence specific to None.
How to add the org admin role to the service account
- Log in to Atlassian Administration with your admin credentials.
- Click Directory > Users.
- Find the service account, then click their avatar or Show details.
- Click More actions () at the top of the page, then select Assign org admin role.
- Click Assign role to confirm.
Once you’ve set up your service account, you’ll need to choose which authentication method you’d like to use to add Confluence to Dash.
How to select the correct authentication method
- The API key method is only available if your Atlassian site has been migrated to the new user management experience. Learn how to check if you’re using the new user management experience.
- Note: If you haven’t been migrated, contact Atlassian Support for more info.
- If your site hasn’t been migrated to Atlassian’s new user management experience, you should use the OAuth method.
- Note: You’ll need to set the default email visibility in your settings to public to use OAuth. Learn more about configuring your email address privacy. This is a requirement for installed apps (like Dash) to access permissioning data.
Method 1: API key method
Note: API keys live for one year by default. You may need to renew them and re-establish the Dash connection after that period.
To use this authentication method, create an API key and an Org API key:
- Learn how to create an API key.
- Learn how to create an org API key.
- Select the following scopes when creating an org API key. Learn more about available scopes.
Scope |
Purpose |
Documentation |
read:classification-levels:admin |
Read classification levels |
Get all classification levels by orgId, Get a classification level |
read:domains:admin |
Read domains |
|
read:policies:admin |
Read policies |
|
read:tokens:admin |
Read API keys and tokens |
Get all API tokens in an org, Get API token count in an org, Get API key count in an org, Get all API keys in an org |
Add Confluence to Dash
- Log in to dash.ai using your admin credentials.
- Click your avatar (profile picture or initials) in the lower left.
- Select Admin console.
- Click Dash in the left sidebar.
- Click Apps.
- Click the More apps tab.
- Click
Add to the right of Confluence.
- Select API Key.
- Enter the subdomain:
- The subdomain is the URL of your Confluence site without https:// (for example, exampleteam1.atlassian.net)
- Enter the API key generated in the section above
- Enter the email address of the service account you created in the previous section.
- Enter the org API key generated in the previous section.
- Click Next.
- Click Done.
- Click the Your apps tab.
You should now see Confluence.
Method 2: OAuth method
Notes:
- To set up Confluence using OAuth, you’ll need to set the default email visibility in your settings to public. Learn more about configuring your email address privacy and why it’s safe. This is a requirement for installed apps (like Dash) to access permissioning data.
- The permissions on ingested data may not be complete with the OAuth method if default email visibility isn’t set to public or if individual users override email visibility settings on their Atlassian account.
- If you choose to add Confluence to Dash using the OAuth method, you’ll need to grant the following API permissions:
- Access and sync Confluence content, even when you're not online: This permission is needed to ingest and keep Confluence page content up to date, including when you’re not actively logged in.
- Search and preview Confluence content: This permission enables search functionality and shows previews, summaries, and metadata (like last updated info) in results.
- Display space and page-level metadata: This permission is used to show which space a page belongs to and related space-level info.
- Respect user and group permissions: These permissions ensure only users with the right access can view certain content, based on their identity and group membership.
- Track permission changes to keep results accurate: This permission allows Dash to detect when content access changes, so outdated content is removed from search.
- Access tasks and custom properties in Confluence: This permission ingests Confluence-specific elements like tasks or page-level properties your organization may be using.
Add Confluence to Dash
- Log in to dash.ai using your admin credentials.
- Click your avatar (profile picture or initials) in the lower left.
- Select Admin console.
- Click Dash in the left sidebar.
- Click Apps.
- Click the More apps tab.
- Click
Add to the right of Confluence.
- Select OAuth, then click Start.
- Click Next.
- Complete the Atlassian login steps with your svc-dropboxdash-confluence service account, then click Accept.
- Note: If you require multi-factor authentication (MFA) for accounts in your environment, you may be prompted for additional authentication associated with the service account.
- Click Done.
- Click the Your apps tab.
Respuestas de la comunidad
-
Publicado por: George E. 675 días
2401
2
0