Set up Social Media Authentication

What is Social Media Authentication?

Social Media Authentication will allow users to log in to OrangeHRM Starter using popular providers such as Google, Microsoft, Okta and Keycloak. The OpenID Connect Protocol has been used to implement this feature. This means that you will be able to use any providers that support OpenID Connect to log in to OrangeHRM Starter 5.6 and above. 

How do I set up Social Media Authentication?

Visit Admin > Configurations > Social Media Authentications to add your first authentication provider.

Click the “Add Provider” button and provide the required details. These include:

• Provider Name
• Provider URL
• Client ID
• Client Secret (this value will be hidden after saving)

Please refer to “How to set up popular Providers” for more information.

Add users to OrangeHRM

Please follow the steps below when creating user accounts to ensure that your users can log in via social media.

• Adding New Employees

Go to PIM -> Add Employee

Fill in the necessary details.

Click “Create Login Details” 

Set the employee’s email as the username

The password field is not required if you have added at least one social media provider.

• For Existing Employees

Go to Admin -> User Management -> Users

Click the “+ Add” button to add a new user.

Fill in the necessary details.

Set the employee’s email as the username.

The password field is not required if you have added at least one social media provider.

How can I log in to OrangeHRM using a provider?

Your added provider will appear on the Login page underneath the standard Login button. The provided name and a corresponding icon will be shown. Icons for Google, Microsoft, Okta, Auth0 and Keycloak have been included. For other providers, a 🔓 (lock) icon will show. These included icons will be chosen according to the provider URL.

Upgrading from OrangeHRM 4.x (that has Social Media Auth Enabled)

OrangeHRM 4.x supported OpenID which has been deprecated in favor of OpenID Connect. This means that your configured OpenID providers (other than Google) will not work in OrangeHRM 5.6.

If you had previously configured Google in OrangeHRM 4.x, visit your Google Developer Console and change the Redirect URL from                                                                                                          https://{your-domain}/symfony/web/index.php/openidauth/openIdCredentials to                           https://{your-domain}/web/index.php/openidauth/openIdCredentials after upgrading. If you are still unable to Log in, re-enter the Client ID and Secret in OrangeHRM 5.6.

Which Providers Are Supported?

In OrangeHRM 5.6, the following providers are supported:

• Google
• Auth0
• Okta
• Microsoft
• Keycloak

You can also add any provider that supports OpenID Connect.