Step 1: Setup 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
• Add Realm : Now login to keycloak administration console and navigate to your desired realm. You can add new realm by selecting Add Realm option.

• Create realm: Enter Realm Name and click on CREATE to add realm.
• Create ROLE: The Role will be used by your applications to define which users will be authorized to access the application. Click on the Roles and choose Add Role.

• Add User: We need to add users to realm who will be able to access the resources of realm. Click on the Users and choose to Add a new User.

• User Configuration: After user is created following action needs to be performed on it.
1) Setting a password for it so click on Credentials and set a new Password for the user.



NOTE : Disabling Temporary will make user password permanent.

• Map User: We need to map user to a role. Click on Role Mappings and assign the user desired role from available roles and clicking on add selected.

• Create groups: Click on the Groups and choose New to create a new group.

• Assign user to group: Select the user whom you want to add in group. Choose Groups option from tab and then select the group-name and click on join.

• Create OpenID client: Click on the Clients and choose create to create a new client. Enter client id and select client protocol openeid-connect and select Save.

• Change Access type: After client is created change its access type to confidential.

• Enter Valid Redirect URIs: Copy callback URL from plugin and then click on SAVE. Ex -- https:///oauth/callback
• Keycloak Group Mapper: Now to get group details we need to perform its client mapping with group membership else group details will not be fetched. So in client select Mappers and then click on create. Select mapper type Group Membership and enter name and token claim-name i.e the attribute name corresponding which groups will be fetched. Turn Off full group path and click on Save.


Note: -- If full path is on group path will be fetched else group name will be fetched.

• Realm name: You need a realm name when you set up Keycloak as an OAuth provider. Go to the Realm Settings tab and copy the realm name.
• Get Client Secret: Now we need to get client secret. So select Clients and select credentials and copy your secret from here.

• Plugin Configuration: Enter copied Client Secret here Client ID will be your client name and the URL are given below.



Keycloak Endpoints and Scope:




Client ID :	Click Here
Client Secret :	Click Here
Scope:	email profile openid
Authorize Endpoint:	<keycloak domain>/auth/realms/{realm-name}/protocol/openid-connect/auth
Access Token Endpoint:	<keycloak domain>/auth/realms/{realm-name}/protocol/openid-connect/token
Get User Info Endpoint:	<keycloak domain>/auth/realms/{realm-name}/protocol/openid-connect/userinfo
Custom redirect URL after logout: [optional]	https://{domain-name}/auth/realms/{realm-name}/protocol/openid-connect/logout?redirect_uri=encodedRedirectUri

Step 2: Setup WordPress as OAuth Client

• After Plugin is activated, go to the plugin and search for Keycloak. Select Keycloak from the OAuth Providers list.

• Go to Configure OAuth tab and configure App Name, Client ID, Client Secret from provided Endpoints.
• Enter Scope value as email profile openid.
• Click on Save Settings to save the configuration.

Step 3: User Attribute Mapping.

• User Attribute Mapping is mandatory for enabling users to successfully login into WordPress. We will be setting up user profile attributes for WordPress using below settings.

Finding user attributes

• Go to Configure OAuth tab. Scroll down and click on Test Configuration.

• You will see all the values returned by your OAuth Provider to WordPress in a table. If you don't see value for First Name, Last Name, Email or Username, make the required settings in your OAuth Provider to return this information.

• Once you see all the values in Test Configuration, go to Attribute / Role Mapping tab, you will get the list of attributes in a Username dropdown.

Step 4: Login Settings / Sign In Settings.

• The settings in SSO Settings tab define the user experience for Single Sign On. To add a login widget on your WordPress page, you need to follow below steps.

Sign In Settings

• Go to WordPress Left Panel > Appearances > Widgets.
• Select miniOrange OAuth. Drag and drop to your favourite location and save.

• Open your WordPress page and you can see the login button there. You can test the SSO now.

Additional Add-Ons And Plugin Integrations

BuddyPress Integration

Allows to integrate user attribute information fetched from OAuth / OpenID Identity Providers (IDP) with the user's BuddyPress profile.

Page and Post Restriction

Protects the pages/posts of your site with OAuth/OpenID Connect compliant IDP login page & restrict the access to the site based on the user roles.

Login Form Add-On

Provides a Login form for OAuth/OpenID login instead of button. It relies on OAuth/OpenID sso plugin to have Password Grant configured.

Media Restriction

miniOrange Media Restriction add-on restricts unauthorized users from accessing the media files on your WordPress site.

Discord Role Mapping

Discord Role Mapping add-on helps you to get roles from your discord server and maps it to WordPress users while SSO.

LearnDash Integrator

LearnDash Integration will map the SSO users to LearnDash groups as per the group attributes sent by your Identity Provider.

Attribute Based Redirection

Attribute Based Redirection plugin can be used to restrict and redirect users to different URLs based on OAuth/OpenID attributes.

SCIM User Provisioning

SCIM User Provisioning allows you to sync user's creation, updation and deletion from your IDP to WordPress site.

SSO Session Management

SSO session management add-on manages the login session time of your users based on their WordPress roles.

Membership Level based Login Redirection

This add-on allows to redirect users to custom pages based on their membership levels after Single Sign-On. Plugin Checks user’s membership level during every login, so any update on the membership level doesn’t affect redirection.

SSO Login Audit

SSO Login Audit captures and tracks all the SSO users and generates reports.

Additional Resources

• What is OAuth 2.0?
• Securing REST API using Keycloak and Spring Oauth2
• Frequently Asked Questions (FAQs)