When integrating HelpKit widgets into your web application, you may want to protect access on your public site while providing seamless access to users already logged into your application. HelpKit’s Bypass Authentication feature allows you to skip the login page for authenticated users, creating a smoother user experience.
Prerequisites
Before implementing bypass authentication, ensure you have:
- A HelpKit widget embedded with protected access enabled
- Users already authenticated in your web application
- Administrative access to your HelpKit widget settings
Implementation Guide
Step 1: Enable Bypass Authentication in Widget Settings
- Navigate to your HABkit widget settings page
- Locate the "Allow Bypass Authentication" section
- Check the checkbox to enable this feature
⚠️ Security Note: This setting must be enabled before the bypass function will work. This is an intentional security measure to prevent unauthorized access.
Step 2: Implement the JavaScript Function
Once a user has successfully logged into your application, call the bypass authentication function:
Helpkit.bypassAuthentication()This function should be called after your user authentication process is complete.
Read more about our Widget SDK here.
Step 3: Test the Integration
- Ensure a user is logged into your web application
- Trigger the HelpKit widget to open
- Verify that the login screen is bypassed and users have direct access to the protected content
Best Practices
- Timing: Call
bypassAuthentication()only after confirming user authentication in your system
- Security: Keep the “Allow Bypass Authentication” setting disabled when not needed
- Testing: Always test the implementation in a staging environment before deploying to production
Troubleshooting
If the bypass isn’t working:
- Verify that “Allow Bypass Authentication” is enabled in widget settings
- Ensure the function is called after user authentication
- Check browser console for any JavaScript errors
By following this guide, you can provide your authenticated users with seamless access to HelpKit widgets while maintaining security for public visitors.
Powered by