Download And Installation

• Log into your atlassian instance as admin.
• Navigate to the settings menu and Click Manage Apps.
• Click Find new apps or Find new add-ons from the left-hand side of the page.
• Locate Api Token/OAuth Authentication app.
• Click Try free to begin a new trial or Buy now to purchase a license.
• Enter your information and click Generate license when redirected to MyAtlassian.
• Click Apply license.

Step 1: Configure Keycloak server:

• In your Keycloak admin console, select the realm that you want to use.
• Go to Clients in the left navigation bar and click on Create.

• Enter the ClientID and select the client protocol as OpenID-connect and click on Save.

• Select access type as Confidential,  enter the redirect URL and click on save (Enter the Application's Base URL).
• To get Client Secret Navigate to Clients, select Client Id and navigate to the Credentials tab.

Step 2: Fetch Access token through POSTMAN

• Open the Postman Application (Here is the link to download Postman Application).
• Go to Authorization tab.
• From the dropdown select type as OAuth 2.0 and  click on Get access token.
• Add the following information from the table below.
• Postman starts the authentication flow and prompts you to use the access token.
• Select Add token to the header.

• Copy the Access Token or click on Use Token.

A834c0606ba71336423013699db8e971

Step 3: Fetch Username through Keycloak:

• Choose the method type as "GET".
• Enter the interoception Endpoint from the plugin to fetch the username in the Request URL. For Keycloak it is "http://{host_name}/auth/realms/{realm_name}/protocol/openid-connect/userinfo".
• Go to the Authorization tab select the Bearer Token and enter the access token here.
• Add the header "content-type: application/json" and click on Send.

     curl 
     -X GET 
     -H "Authorization: Bearer <Access Token>" 
     -H "Content-type: application/json" 
     http://{hostname}/auth/realms/{realm_name}/protocol/openid-connect/userinfo

Configure the Rest API plugin:

Step 1: Enable Rest API Authentication:

• After installing the app, navigate to the Global Settings tab.
• Here you will have to Enable the Authentication through Enable REST API Authentication and click on Save.
• Go to the OAuth/OIDC tab and in the dropdown provided select Keycloak as the OAuth provider.
• Enter the Host Name and the Realm name from Keyclok.
• Enter the attribute value against which we received the username in the Postman response.
• Save the settings.

Step 2: Disable Basic Authentication:

• Disabling this will restrict all the REST API call made using Basic Authentication.

Test REST API using access token:

• Call any REST API. Include the access token in the Authorization header. Here’s an example of fetching content from Confluence.
• Go to the Postman application select method type as GET and enter the Request URL. For eg. http://{Confluence_Base_URL}/confluence/rest/api/content/
• In the Authorization tab select type as Bearer Token.

• In the Header tab add the header “content-type: application/json and send the request.

     curl 
     -X GET  
     -H "Authorization: Bearer <Access Token>" 
     -H "Content-type: application/json" 
     http://{confluence_base_url}/confluence/rest/api/content/

• This will show the content in Confluence and will return the status 200.
• If the token is invalid or missing, the call will return a 401 Unauthorized response

Additional Resources

• Rest API Authentication Methods
• Keycloak as OAuth Provider/OpenID Connect
• Frequently Asked Questions (FAQs)