OAuth 2.0 support in Bold BI application

The Bold BI application can be configured to support OAuth 2.0 for Single Sign-On (SSO), so that the users can log in directly to Bold BI application after authenticating using the OAuth 2.0.

Prerequisites

1. An account with an OAuth 2.0 provider.

2. Register the Bold BI application in the OAuth 2.0 provider.

Steps to configure OAuth 2.0 in Bold BI

1. Login to the Bold BI with the admin credential.

2. Click Settings in the left side menu.

   

3. Click Authentication and then OAuth 2.0

   

4. Provide the following details in the OAuth 2.0 settings of Bold BI application.

   Provider Name	It represents the name of the authentication provider to be displayed in the login page.
   Provider Logo	It represents the logo of the authentication provider to be displayed in the login page.
   Authorization Endpoint	It is the endpoint in the provider to authorize the user.
   Token Endpoint Method	It represents the request type to access the token endpoint.
   Token Endpoint	It is the endpoint in the provider that generates the token.
   User Information Endpoint Method	It is the endpoint in the provider used to get the user details.
   User Information Endpoint	It represents the request type to access the user information endpoint.
   Client ID	It is an unique identifier provided to each of the applications while registering in the providers.
   Client Secret	It is a secret key that is used to authorize the applications.
   Scopes	It is comma separated lists of identifiers that specifies the access privileges that are being requested from the provider.
   Logout Endpoint	It is an end point that logout the thrid-party provider.
   Email	This must be the field name in which email will be present when deserializing the token.

   

   

If we need to import the OAuth 2.0 groups, we have to configure the group details while saving the OAuth authentication settings.

The previous mentioned similar steps are applicable to configure the OAuth 2.0 support in User Management Server by logging into the URL {Bold BI URL}/ums/administration/sso?view=oauth-settings with admin credential.

The following are the list of few OAuth 2.0 providers and that explains how to connect with the Bold BI application.

• Amazon Cognito
• Auth0
• Okta
• OneLogin

The OAuth 2.0 support is provided in both the Bold BI sites and User Management Server. This support can be handled for each sites individually in the settings page by disabling the option as in the following screenshot.

Set OAuth 2.0 as Default Authentication

OAuth 2.0 can be set as default authentication when OAuth 2.0 settings is enabled and saved. Follow these steps:

1. In settings page, click Authentication tab and select General.

2. Enable the Enable Default Authentication option and select the OAuth 2.0 in default authentication provider as in the following screenshot.

   

Disabling OAuth 2.0 Settings

When OAuth 2.0 is set as default authentication and try to disable the OAuth 2.0 settings will display below pop-up. Proceeding by clicking Yes will disable the OAuth 2.0 default authentication.