Steps to configure Keycloak as OAuth Provider:

• First of all, Download Keycloak and install it.
• Start Server: Start the keycloak server by running the _standalone.sh_ file Root Directory of keycloak/bin/standalone.sh
• Create Realm: Now login to keycloak administration console and navigate to your desired realm. You can add a new realm by selecting Create Realm option.

• Create Realm: Enter Realm Name and click on CREATE to add realm.

• Enter the Client ID and click on the Save button.

• Enable the Client authentication and click on the Save button.

• Paste the copied (in step1) callback url into the Valid Redirect URLs text area and click on the Save button.

 Integrating Drupal with Keycloak

• Copy the Client ID from the Keycloak application, client ID will be your client name.

• Navigate to the Credentials tab and copy the Client Secret.

• In Drupal’s Configure OAuth tab paste the copied Client ID and Client Secret (copied from the Keycloak Portal) in the Client ID and Client Secret text-field.

• Copy the Keycloak Domain and Keycloak realm.
• Replace the copied Keycloak Domain & Keycloak realm with the {your Domain} and {realm-name} in the Authorize Endpoint, Access Token Endpoint, and Get User Info Endpoint respectively.
• Click on the Save Configuration button.

• Keycloak Scope and Endpoints:

Scope:	openid email profile
Authorize Endpoint:	(Keycloak base URL)/realms/{realm-name}/protocol/openid-connect/auth
Access Token Endpoint:	(Keycloak base URL)/realms/{realm-name}/protocol/openid-connect/token
Get User Info Endpoint:	(Keycloak base URL)/realms/{realm-name}/protocol/openid-connect/userinfo

 Test Configuration of Drupal with Keycloak

• Now, click on the Perform Test Configuration button.

• This Test Configuration will give you the list of the attributes that are coming from Keycloak.

• Now, after clicking on the Done button, you will be redirected to Attribute & Role Mapping tab. Under this tab, select the Email Attribute from the dropdown list. If the attribute is not listed, you can select custom and then enter the attribute in the text field.

• Now, select the Username Attribute from the dropdown list. If the attribute is not listed, you can select custom and then enter the attribute in the text field.

• Now, click on the Save Configuration button.


Please note: This step is mandatory for your login to work. Click on the Save Configuration button to save your attribute configurations.

• If your OAuth Provider supports only HTTPS Root URL or Base URL (for eg. Azure, Azure B2C) you can change it under the Sign In Settings tab.

• Now open the incognito window and go to your Drupal site’s login page. You will automatically find a Login with link there. If you want to add your login link to other pages as well, please follow the steps given in the below image: