Setup
Connect to your Confluence app for OAuth
To setup your Confluence app in Cobalt for OAuth, you will need the following credentials from your Confluence Developer account:
- Client ID
- Client Secret
- Scopes
Pre-requisites
- Confluence Developer Portal. You can create one here.
Required Settings
- Mandatory Scopes
- offline_access
Creating an app in Confluence
To create a Confluence app and aquire the above mentioned credentials, please follow the steps mentioned below:
- Log in to your Confluence Developer Portal.
- Click on the
Create
button in the right and selectOAuth 2.0 integration
.
- Enter the App Name for your application, agree to the Developer’s terms and click on
Create
. - Go to your
Apps catalog
in Cobalt > Search forConfluence
>Settings
>Use your credentials
>Callback Url
> Copy it. - Navigate to
Authorization
in the side menu > Click onAdd
button under Action > Paste the Callback Url > Click onSave changes
.
- Navigate to
Permissions
in the side menu > Click onAdd
button in Jira API > Click onConfigure
. - Navigate to Classic scopes tab > Click on
Edit Scopes
button in Confluence API > Select scops > Click on theSave
button.
- Navigate to
Distribution
in the side menu > Click on theEdit
button > Change distribution status toSharing
and provide Vendor and Security Details > Click onSave Changes
.
Note: Changing Distribution Status from Private to Sharing is necessary, otherwise only the Developer account user can install and use it.
- Navigate to
Settings
in the side menu, scroll down and copy the Client ID and Secret from Authentication details section.
Configuring credentials in Cobalt
App settings page lets you configure the authentication settings for an OAuth2
based application. For your customers to provide you authorization to access their data,
they would first need to install your application. This page lets you set up your application credentials.
Cobalt lets you use pre-configured applications to play around. You can do so by selecting Use our credentials
. However, if you wish to use your own application,
select Use your own credentials
. Provide the aquired Client Id and Client secret and click on Save changes
.
Configuring Scopes
Cobalt lets you configure what permissions to ask from your users while they install your application. The scopes can be added or removed from the App settings page, under Permissions & Scopes
section.
For some applications Cobalt sets mandatory scopes which cannot be removed. Additional scopes can be selected from the drop down. Cobalt also has the provision to add any custom scopes supported by the respective platform.
Once the scopes has been added to the application in Cobalt, go to your Confluence Developer Portal and update the scopes as added on Cobalt.
Select the OAuth App created for Cobalt > Click on Permissions
in the left menu > Click Configure
in Confluence API > Click on Edit Scopes
> Select the scope > Click on Save
.
If you are facing scopes missing or invalid scope error. Make sure you are not passing any custom scope not supported by the platform. And, the scopes selected here are identical to the ones selected in the platform.
Actions and triggers
Once the above setup is completed, you can create orchestrations of your use-cases using Confluence actions and triggers. Following are the set of Confluence actions and triggers supported by Cobalt.