US English (US)
FR French
DE German
SA Arabic
BS Bosnian

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Book a Demo
  • Product Updates
  • Contact Us
English (US)
US English (US)
FR French
DE German
SA Arabic
BS Bosnian
  • Home
  • Authentication

Single Sign On with JSON Web Token

Written by Diego Selzlein

Updated at December 5th, 2022

Contact Us

If you still have questions or prefer to get help directly from an agent, please submit a request.
We’ll get back to you as soon as possible.

Please fill out the contact form below and we will reply as soon as possible.

  • Integrations
  • Getting Started
    Users Accessibility New to Helpjuice? Start Here Content Management Multiple Languages/Translations & Localization Multilingual Knowledge Bases Analytics Video Tutorials
  • Customization
    Customization Guides
  • API V2
  • API V3
  • Article Editor
  • Swifty (In-App Widget)
  • Billing / Subscription
  • Authentication
+ More

Helpjuice supports authenticating users via Single Sign On with JWT. It works like this:

  1. The user chooses to authenticate through SSO
  2. Helpjuice redirects the user to your website where they can authenticate with user / password
  3. Your website generates a JSON Web Token using the shared key Helpjuice provides and redirects the user with the token back to Helpjuice
  4. Helpjuice decodes the token and authenticate the user with the email you provided
  5. If the user is a new one, we will create a new user account for him


To set it up, go to your account Settings > Single Sign On with JWT


Then fill in the form:


JWT Fields


These are the fields that Helpjuice will use from your JSON Web Token:

Field Required? Description
jti yes This field contains an unique token ID generated by your website. Helpjuice will use it to prevent replay attacks.
iat yes This field has to contain the token creation time in milliseconds since Unix epoch. Helpjuice will only accept tokens up to 3 minutes old.
email yes The authenticated user's email so Helpjuice can identify the user.
first_name no The user's first name.
last_name no The user's last name

In order to debug issues with your token, use https://jwt.io. It provides a tool to parse your token and show you if it's using the right layout.

Signing Users In


When Helpjuice redirects a user to your login page, it will append a parameter to the URL called service and set it to helpjuice, like: https://my.website.com/login?service=helpjuice. This may be useful for you to identify the service and properly configure the authentication token layout.

Upon successful authentication, you need to sign the generated token with the Shared Secret Helpjuice provides you in that Settings page. Then you need to redirect them to https://helpjuice.com/jwt/YOUR_SUBDOMAIN?jwt=YOUR_ENCODED_TOKEN.

Redirection after sign in

If the user was trying to access a restricted page when we sent him to your server for login, we also append a query parameter called fallback_url set to the original request URL, like: https://my.website.com/login?service=helpjuice&fallback_url=https://yourdomain.helpjuice.com/article-url.

Your server should send the value of this field back to Helpjuice in the fallback_url query parameter, like: https://helpjuice.com/jwt/YOUR_SUBDOMAIN?jwt=YOUR_ENCODED_TOKEN&fallback_url=https://yourdomain.helpjuice.com/article-url.

If you don't send the fallback_url parameter back to Helpjuice, we wil try to redirect using session cookie values, and, if that isn't possible, we will redirect the user based on the configuration in the User Behavior & Tracking settings page.

Signing Users Out


After signing a user out, Helpjuice will redirect them to the Logout URL you provided (if present).

jwt sso

Was this article helpful?

Yes
No
Give feedback about this article

Related Articles

  • ActiveDirectory and LDAP
  • Single Sign On with ActiveDirectory Federation Services (ADFS)
  • Google Sign In

Copyright © 2023 - Helpjuice

Helpjuice, Inc. is a registered US Corporation, EIN # 45-2275731

Download W9
  • Help
  • Features
  • Pricing
  • About
  • Careers
  • Customers
  • Blog
  • Case Studies
  • Resources
  • Knowledge Base Examples
  • Privacy Policy
  • Terms of Service

Why is the knowledge base important?

With a knowledge base, you can allow your customers to self-help themselves, thus reducing your customer support by up to 60%. Furthermore, you can also have your team get instant answers to the questions they need without having to email themselves all using knowledge base software.

What is the purpose of a knowledge base?

The purpose of knowledge base software is to allow you to host your knowledge base/corporate wiki in one centralized 'hub'. Both your customers, and employees can now access information within seconds!

Made with from Miami, Bosnia, Morocco & Brasil

+1 (833) 387 3877 success@helpjuice.com
Expand