Creating a Custom OAuth Application
CData embeds OAuth application credentials with CData branding that can be used when connecting to Confluence Cloud via a desktop application or a headless machine. However, a custom OAuth application is required to connect to Confluence Cloud via the Web, or to authenticate via OAuth with a Confluence Data Center (on-premises) instance. Custom OAuth applications are also useful if you want to:
- control branding of the authentication dialog;
- control the redirect URI that the application redirects the user to after the user authenticates; or
- customize the permissions that you are requesting from the user.
For information on connecting using embedded OAuth application credentials, see the Desktop Applications section in Configuring a Connection.
Create an OAuth Application
Confluence Cloud
To obtain the OAuth client credentials (OAuthClientId and OAuthClientSecret):
- Log in to your Confluence Cloud site.
- Navigate to your application management page.
- Select Create new app, then name the application. The application is created.
- Select your newly created application from the list.
- To add OAuth 2.0 functionality to your application, navigate to Authorization then select Add for the OAuth 2.0 (3LO) authorization type.
- Navigate to Permissions. Next to Confluence API, select Add.
- Select Configure and add the desired scopes to your application. Please note that you also need to add the Confluence application to get all of the functionalities of the connector.
- You also need to set your Callback URL. Navigate to Authorization > OAuth 2.0 (3LO) > Configure . Enter a URL that is accessible to your application and save the changes.
- Navigate to Settings. Under Authentication details, the client Id and client secret are displayed.
Confluence Data Center
To obtain the OAuth client credentials (OAuthClientId and OAuthClientSecret):
- Go to Administration menu > General Configuration > Application links.
- Select Create link.
- Select External application and choose Incoming as the direction.
- Fill in the following details:
- Application Name: A name for the application.
- Redirect URL: The callback URL of your application.
- Application Permissions: The permissions the application requires.
- Select Save. Confluence generates the OAuth credentials, including the client Id and client secret.