Custom Provider Integration
Table of Contents
Overview
1.1 Purpose
1.2 Scope
Integration Steps
2.1 Project Integration
2.2 Custom Provider in Admin Settings
2.3 Google API Setup
2.4 Licentio Provider Integration
Conclusion
1. Overview
1.1 Purpose
The purpose of this documentation is to guide administrators through the process of integrating custom authentication providers as custom providers using OAuth and OpenID Connect protocols.
This integration expands user login options and enhances security through industry-standard authentication methods.
1.2 Scope
This documentation covers the steps required for administrators to integrate various authentication providers as custom providers.
These providers offer OAuth and OpenID Connect support, allowing users to log in to your system using their accounts from these providers securely.
2. Integration Steps
Admins can enhance their application's authentication options by integrating custom authentication providers that support OAuth and OpenID Connect.
These providers offer a seamless way for users to log in using their existing accounts from those platforms.
2.1 Project Integration
In your application's admin panel, navigate to the settings-> Custom Providers.
Refer: Custom Providers.
Create the desired custom provider (Google, Facebook and any other provider supports OAuth and OpenID Connect.).
2.2 Custom Provider in Admin Settings
After successfully integrating the custom authentication provider on the admin side, it will appear in the Custom Providers section of your application's admin settings. Example: Google Provider Integration
As an example, we'll guide you through integrating Google as a custom provider.
Admins can follow the steps mentioned in the Project Integration section using the provided URLs from the Google Cloud Console and Google Developers Console.
2.3 Google API Setup
Admins access the Google Cloud Console and create a new project.
Enable the Google+ API for the project to allow user profile information access.
OAuth2
Obtain Client ID and Client Secret
Access the Google Developers Console and select the project.
Configure OAuth consent screen settings (e.g., application name, user support email).
Create OAuth 2.0 credentials and obtain the client ID and client secret.
2.4 Example: Licentio Provider Integration
For this example, we'll integrate Licentio as a custom provider. Here's the specific process:
In your admin panel, navigate to the Clients -> Client Settings section.
Refer:
Client SettingsCreate a new client for Licentio, which will generate a client ID and client secret.
Return to the Custom Providers section and follow the remaining steps by creating Licentio as the custom provider and entering the obtained client ID and secret.
Configure OpenID Connect settings with the issuer URL as instructed.
The issuer URL also serves as a discovery endpoint. By appending the well-known path /.well-known/openid-configuration to the issuer URL, clients (applications) can retrieve metadata about the OpenID provider. This metadata includes information such as supported endpoints (authorization, token, userinfo, etc. )
Once the Licentio Custom Provider is created it will show in the Social Login Providers list.
2.4.1 Integrating Licentio User Login
To integrate Licentio user login into your user applications, follow these steps:
Navigate to the flow settings in Admin panel.
Choose the authentication flow that corresponds to the Licentio integration.
Configure the Login settings flow and include Licentio as an authentication option.
Refer: Login Settings
Here we can configure Licentio as a Login Provider.
Users will now be able to log in to your application using their Licentio accounts.
3. Conclusion
In summary, when we combine custom authentication providers that work with OAuth and OpenID Connect, we make user logins safer and easier.
By following the steps to getting the needed credentials, setting up OpenID Connect, and smoothly adding these options, administrators enable users to access their accounts with confidence and security.
This combination ensures a smooth user experience and strong security.
Last updated