JWT Authentication

Custom Authentication

The Custom JWT authentication provider allows users to authenticate with an authentication system that is independent from Tiledesk. The external system must return a signed JSON Web Token that contains a unique ID value for the authenticated user.

Tiledesk uses the JWT to identify your application’s users and authenticate their requests but does not impose any restrictions on the external authentication system’s requirements or authentication methods.

To create a Custom JWT Token you must generate a Project Shared Secret as described below.

NOTE: We provide a full tutorial on Custom Authentication.

---

Generating a Project Shared Secret

A Project Shared Secret is a security setting, intended to be generated, copied, and pasted into a communication with your engineering team, or directly into your codebase, in a single sitting. It should not be entered into a browser.

To generate the shared secret required for custom authentication you need:

• Open the Dashboard and go to Project Name > Project Settings.

• Go to the Visitor Authentication tab and click the Generate button.

The shared secret is intended to remain secure. It will only appear in full one time. If you don’t have access to the shared secret and need the full secret to create your token, you can reset the secret by clicking the "Generate" button. Regenerating a new shared secret will revoke previous tokens. If you believe the shared secret has been compromised, regenerate it. When rotating keys, schedule it when Chat is offline because regenerating the secret causes visitors to be disconnected from the widget.

---

Create a Tiledesk JWT token

To create a JWT token you must set the following required fields of the user object:

• _id — the custom unique user identifier of the external authentication system. It must start with <YOUR_PROJECT_ID>_ (example: 5e5f4e220b28440012117be4_12345678)

• sub — JWTs describe their subject in the sub claim. For custom authentication the sub field must be equal to userexternal

• aud — JWTs describe their audience in the aud claim. For custom authentication it must be https://tiledesk.com/projects/<YOUR_PROJECT_ID> whether you use the cloud version of Tiledesk or if you install it on-premise.

• email — the user email

Optional fields:

• firstname — the user firstname

• lastname — the user lastname

• attributes — other custom jwt claims

The external authentication system must create the JWT signing the user object with the Project Shared Secret code.

User object example:

user-payload.json

{"_id": "5e5f4e220b28440012117be4_12345678", "firstname":"Andrea", "lastname":"Leo", "email": "[email protected]",  "attributes": {"attribute1":"value"}, "sub":  "userexternal",  "aud":  "https://tiledesk.com/projects/5c81593adf767b0017d1aa68"}

---

Generate JWT Token Server Side

Find the template below that fits your language needs. Customize the sample as needed, making sure to replace the #{details} with your own information.

If none of these samples match your needs, JWT has a more extensive list of JWT libraries to explore.

NodeJS

Install jsonwebtoken:

Install

npm install jsonwebtoken --save-dev

Generate a token using the shared secret:

example.js

var jwt = require('jsonwebtoken');
var payload = {
  _id: '#{customerIdentifier}',
  firstname: '#{customerFirstname}',
  lastname: '#{customerLastname}',
  email: '#{customerEmail}',
  sub: 'userexternal',
  aud: 'https://tiledesk.com/projects/#{YOUR_PROJECT_ID}',
};
var token = jwt.sign(payload, '#{yourProjectSharedSecret}');

You can find a NodeJs Custom Jwt Authentication example here.

PHP

Download PHP-JWT:

Install

composer require firebase/php-jwt

Generate a token using the shared secret:

example.php

$payload = {
  '_id' => '#{customerIdentifier}' ,
  'firstname' => '#{customerFirstname}',
  'lastname' => '#{customerLastname}',
  'email' => '#{customerEmail}',
  'sub' => 'userexternal',
  'aud' => 'https://tiledesk.com/projects/#{YOUR_PROJECT_ID}'
};
$token = JWT::encode($payload, '#{yourProjectSharedSecret}');

Java

Authentication with Java is covered with a simple Java (Maven) example on the public repo TiledeskJavaJWTSign.

We use the JJWT library to implement the Tiledesk JWT sign operation.

Java snippet

SignatureAlgorithm signatureAlgorithm = SignatureAlgorithm.HS256;
long nowMillis = System.currentTimeMillis();
Date now = new Date(nowMillis);
byte[] apiKeySecretBytes;
apiKeySecretBytes = SECRET_KEY.getBytes();
Key signingKey = new SecretKeySpec(apiKeySecretBytes, signatureAlgorithm.getJcaName());
JwtBuilder builder = Jwts.builder().setId(id)
        .setIssuedAt(now)
        .setSubject(subject)
        .setIssuer(issuer)
        .claim("firstname", firstname)
        .claim("lastname", lastname)
        .claim("email", email)
        .signWith(signingKey, signatureAlgorithm);

return builder.compact();

Please refer to the above mentioned repo for further details.

---

Verify the token

You can verify the JWT token using jwt.io following these steps:

1

1. Paste the secret code

2

1. Paste the jwt code in the left column

3

1. Check the "Signature Verified" label

---

Widget Authentication

See how to setup custom authentication for the widget using the JWT token.