OTP templates — Versola Docs
/docs
До 1.00.7.5versola.ioGitHub

OTP templates

Справочник по странице OTP templates консоли администратора — SMS- и email-тексты одноразовых кодов и временных паролей для тенанта и языка

Страница OTP templates перечисляет сообщения, в которых auth отправляет одноразовый код или временный пароль. Сначала выберите тенант в боковой панели: шаблоны принадлежат ему. У каждого шаблона по одному тексту на каждый активный язык.

Перед началом

Что нужноРазрешение
Открыть страницуsecurity:read
Создавать, менять и удалять шаблоныsecurity:manage

Без security:manage страница доступна только для чтения: кнопки + Create Template, кнопки Edit и действий удаления нет. Языки берутся из карточки Locales в System settings; текст нужен только для активных языков.

Список

OTP templates, список
Страница OTP templates: поле поиска, фильтры All, OTP, Password, SMS, Email и Missing translations и таблица шаблонов с колонками Template, Type, Channel и Languages.

В таблице одна строка на шаблон, колонки Template (ID), Type, Channel и Languages. Поиск сопоставляется с ID шаблона. Фильтры сужают таблицу по типу (OTP, Password), по каналу (SMS, Email) или до шаблонов, у которых нет текста для активного языка (Missing translations). В меню строки есть Open, Copy template ID и Delete template. Выбор строки открывает боковую панель шаблона.

КолонкаЗначение
TypeOTP (одноразовый код) или Password (временный пароль, который уходит, когда администратор сбрасывает пароль пользователя).
ChannelSMS или Email.
LanguagesУ каких активных языков есть текст.

Шаблон определяют вместе ID, тип и канал, поэтому у одного ID могут быть SMS- и email-версия или версии OTP и password. Панель перечисляет их в Other variants. Клиент выбирает шаблон OTP по ID в блоке OTP Settings (OTP Template и OTP channel, см. Клиент). Шаблон password ищется только по каналу: auth берет единственный шаблон password выбранного администратором канала, какой бы у него ни был ID.

Панель шаблона

Шаблон OTP в боковой панели
Боковая панель email-шаблона OTP: карточка Message с HTML-предпросмотром для каждого языка и карточка Fixed с ID, типом и каналом шаблона.

В панели:

  • Message — по записи на язык. SMS показано обычным текстом; тело письма показано так, как его увидит получатель, в изолированном фрейме. Edit карточки открывает редактор сообщения.
  • Fixed — ID, тип и канал: они входят в ключ шаблона и не меняются. Чтобы изменить одно из них, создайте новый шаблон и удалите старый.
  • Other variants, если такой же ID есть для другого типа или канала.
  • Delete template с подтверждением.

Предупреждение вверху панели, Missing translations for …, появляется, когда у активного языка нет текста. Edit Message добавляет его.

Create a template

+ Create Template открывает боковую панель в режиме создания.

Create template
Панель Create template поверх списка: выбор Type и Channel и по одному тексту сообщения на каждый активный язык, в каждом есть плейсхолдер {{code}}.
ПолеПравила
Template IDОбязательное. Строчные буквы, цифры, подчеркивания и дефисы, первая — буква. По нему клиенты ссылаются на шаблон.
TypeOTP или Password.
ChannelSMS или Email. SMS — обычный текст. Email-шаблон должен содержать корректный HTML и пишется в редакторе кода, для каждого языка есть переключатель Preview.
MessageПо одному тексту на каждый активный язык.

Плейсхолдеры проверяются при сохранении, в консоли и еще раз в Central:

ТипОбязательные плейсхолдерыДругие плейсхолдеры
otp{{code}}{{appName}} заменяется именем клиента на языке пользователя.
password{{password}} и {{expiresHours}}нет

Текст auth выбирает так: сначала UI-локали пользователя, затем локаль по умолчанию, затем любая доступная локализация.

Delete a template

Delete template удаляет шаблон для его типа и канала после подтверждения. Central не проверяет, пользуется ли им еще какой-нибудь клиент. Если у клиента указан ID, для которого нет шаблона его канала, отправлять нечего, поэтому сначала смените OTP Template у клиента, а потом удаляйте старый шаблон.

Что дальше

  • Security — длина кода и интервал повторной отправки
  • System settings — включение языков, на которых пишутся тексты
  • Клиент — выбор шаблона клиента