Підписана ідентичність
Звичайний виклик uj.identify надходить із браузера, тому його може змінити будь-хто. Підписана ідентичність запобігає підміні: ваш сервер підписує короткостроковий токен HS256 JWT, який підтверджує особу користувача, а віджет передає цей токен у UserJot.
Усе, що міститься в токені (ідентифікатор користувача, електронна адреса, ім’я, аватар, властивості та компанії), вважається перевіреним.
Коли це потрібно
Ви хочете перевірити, що відгуки, голоси та розмови надходять від справжнього облікового запису користувача, який увійшов у систему.
Ви хочете, щоб клієнти могли редагувати й видаляти власні дописи з відгуками та коментарі у віджеті (непідписані сеанси
uj.identifyне можуть редагувати чи видаляти вміст у віджеті).Ви ввімкнули Вимагати підписані токени у розділі Налаштування → Вхід (доступно в тарифах Starter і Professional після ввімкнення Автоматичного входу). Цей параметр відхиляє непідписані виклики identify, а також вимагає включати членство в компаніях до підписаного токена (не враховуючи непідписані дані на стороні клієнта
companiesта показуючи попередженняUNSIGNED_COMPANY_IGNORED).Віджетом користується адміністратор або власник робочого простору. Ідентифікація без підпису для привілейованих облікових записів ніколи не приймається. Підписаний токен застосовує їхні властивості та компанії; ім’я, аватар і електронна адреса надалі керуються на інформаційній панелі, а якщо їх передати, повертається попередження
PRIVILEGED_PROFILE_IGNORED.
Якщо ваш продукт використовує і вебвіджет, і Swift SDK, увімкнення параметра Вимагати підписані токени забезпечує перевірку в обох випадках. Вебвіджет використовує HS256 JWT (token), а Swift SDK — HMAC-SHA256 signature, підписаний тим самим секретом робочого простору.
1. Створіть токен на своєму сервері
Підпишіть JWT за допомогою HS256 і секрету робочого простору. Знайдіть Ідентифікатор проєкту і Секрет проєкту у розділі Налаштування → Вхід → Секрети.
Ніколи не підписуйте токени в браузері. Зберігайте секрет на своєму сервері.
Обов’язкові твердження
Твердження | Значення |
|---|---|
| Стабільний ідентифікатор користувача у вашій системі. Обов’язковий. |
| Ідентифікатор вашого проєкту UserJot. Обов’язковий. |
| Точний рядок |
| Часова позначка видачі у форматі Unix (секунди). Обов’язкова. |
| Часова позначка завершення терміну дії у форматі Unix (секунди). Обов’язкова. Не більше ніж через 1 годину ( |
Необов’язкові перевірені твердження
Також можна включити email, firstName, lastName, avatar, traits і companies. Кожен запис у companies підтримує:
{
"companies": [
{
"id": "acme",
"name": "ACME Inc.",
"domain": "acme.com",
"logo": "https://acme.com/logo.png",
"traits": { "plan": "enterprise" }
}
]
}Приклади для сервера
Node.js
import jwt from 'jsonwebtoken';
export function createUserJotToken(user, secret, projectId) {
return jwt.sign(
{
sub: user.id,
email: user.email,
firstName: user.firstName,
lastName: user.lastName,
iss: projectId,
aud: 'userjot'
},
secret,
{ algorithm: 'HS256', expiresIn: '1h' }
);
}Python
import time
import jwt
def create_userjot_token(user, secret, project_id):
now = int(time.time())
return jwt.encode(
{
"sub": user["id"],
"email": user["email"],
"firstName": user["first_name"],
"lastName": user["last_name"],
"iss": project_id,
"aud": "userjot",
"iat": now,
"exp": now + 3600,
},
secret,
algorithm="HS256",
)PHP
<?php
use Firebase\JWT\JWT;
function createUserJotToken(array $user, string $secret, string $projectId): string
{
$now = time();
return JWT::encode([
'sub' => $user['id'],
'email' => $user['email'],
'firstName' => $user['firstName'],
'lastName' => $user['lastName'],
'iss' => $projectId,
'aud' => 'userjot',
'iat' => $now,
'exp' => $now + 3600,
], $secret, 'HS256');
}Ruby
require 'jwt'
def create_userjot_token(user, secret, project_id)
now = Time.now.to_i
payload = {
sub: user[:id],
email: user[:email],
firstName: user[:first_name],
lastName: user[:last_name],
iss: project_id,
aud: 'userjot',
iat: now,
exp: now + 3600
}
JWT.encode(payload, secret, 'HS256')
endСтворюйте новий токен під час кожного завантаження сторінки або на автентифікованій кінцевій точці бекенду. Оскільки термін дії токенів спливає щонайпізніше через 1 годину, не кешуйте їх довше.
2. Передайте токен для ідентифікації
Передайте JWT у полі token:
uj.identify({
token: 'TOKEN_FROM_YOUR_SERVER'
});Також можна передавати user і companies разом із token, щоб додати неперевірені поля. Якщо поле є в обох, пріоритет має підписаний токен (якщо не ввімкнено Вимагати підписані токени — тоді непідписані компанії ігноруються). Перевірте, чи пройшла перевірка, за допомогою поверненого промісу:
const result = await uj.identify({ token });
result.identityTrust; // 'signed'Недійсні токени спричиняють помилку, а не перехід до запасного варіанта
Якщо термін дії токена сплив, його формат неправильний або він підписаний неправильним секретом, uj.identify відхиляє проміс із IDENTIFY_FAILED замість непомітного переходу до непідписаного сеансу.
Підписана ідентичність і розмови
Якщо анонімний відвідувач починає гостьову розмову, а згодом ідентифікується за допомогою підписаного токена, його гостьова розмова переноситься до перевіреного облікового запису учасника.
Розмови, розпочаті з підписаною ідентичністю, залишаються захищеними. Щоб відкрити їх знову без підписаного сеансу, відвідувачеві потрібно пройти перевірку, перш ніж переглядати історію.
Увімкнення параметра Вимагати підписані токени і далі дозволяє анонімним відвідувачам починати гостьові розмови, прив’язані до браузера; цей параметр лише забороняє непідписаним викликам
identifyприв’язуватися до облікових записів учасників.
Ідентичність зберігається на ваших публічних сторінках
Після ідентифікації віджет автоматично передає сеанс за посиланнями на ваші загальнодоступні сторінки UserJot (дошку, дорожню карту, журнал змін або центр довідки). Щоб відвідувачі переходили на ці сторінки вже з виконаним входом, увімкніть Автоматичний вхід у розділі Налаштування → Вхід (план Starter або Professional). Див. Автоматичний вхід.
Усунення несправностей
Виклик ідентифікації відхиляється з помилкою IDENTIFY_FAILED
Переконайтеся, що токен підписано за допомогою HS256 і поточного секрету проєкту.
Переконайтеся, що
issвідповідає вашому ідентифікатору проєкту, аaudточно дорівнюєuserjot.Переконайтеся, що наявні і
iat, іexp, задані у форматі Unix (секунди), а такожexp - iat <= 3600.Переконайтеся, що годинник сервера показує точний час (токени, видані в майбутньому, відхиляються, якщо розбіжність перевищує 60 секунд).
Непідписана ідентифікація перестала працювати
Параметр Вимагати підписані токени увімкнено в розділі Налаштування → Вхід (відображається, коли ввімкнено Автоматичний вхід). Після ввімкнення кожен виклик identify має містити дійсний підписаний token.