Creating an allowlist when basic authentication is disabled

When basic authentication is disabled in your environment, you can still create an allowlist for specific users and URLs to use basic authentication in REST API calls.

Before you begin

To be able to block basic authentication and create allowlist with exception in your environment, you must first install the SSO for Atlassian Data Center app from Atlassian Marketplace. This feature is supported in Data Center versions of Jira and Confluence. For the complete list of supported versions of these products, see Atlassian Marketplace.

To create an allowlist

1. To access basic authentication configuration, send the GET request to:

   ${productBaseUrl}/rest/basicauth/1.0/config

   Here's an example of response to this request:

   {
       "block-requests": true,
       "allowed-paths": ["/rest/greenhooper/*"],
       "allowed-users": ["admin", "john"]
   }

2. To update basic authentication configuration, send the PUT request to:

   ${productBaseUrl}/rest/basicauth/1.0/config

   In the body, you can configure the allowlist and if basic authentication should be enabled/disabled:

   {
       "block-requests": true,
       "allowed-paths": ["/rest/greenhooper/*"],
       "allowed-users": ["admin", "john"]
   }
   

   allowed-paths and allowed-users accepts wildcard (“*”) which replaces any list of characters.

   Configuration properties are independent, which means that you can change only allowed-users e.g.

   {
       "allowed-users": ["admin", "normalUser", "testUser"]
   }

   block-requests and allowed-paths in such case will not be affected.