> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Колекція Tokens

`tokens` зберігає одноразові токени: секрет у посиланні, за яким можна встановити пароль. Один документ відповідає одному токену. Моделі Mongoose немає; web пише до колекції через `services/web/app/src/Features/Security/OneTimeTokenHandler.mjs` нативним драйвером.

#### Поля

| Поле | Тип | Значення | Джерело |
| - | - | - | - |
| `_id` | ObjectId | Id документа. | `OneTimeTokenHandler.mjs:40` |
| `use` | String | Призначення токена, див. [Призначення](#uses) нижче. Кожен пошук фільтрує за ним. | `OneTimeTokenHandler.mjs:41` |
| `token` | String | Секрет у посиланні: 32 випадкові байти у вигляді 64 шістнадцяткових символів, зберігається як є. | `OneTimeTokenHandler.mjs:38,42` |
| `data` | Object | Те, що представляє токен; повертається під час його використання. | `OneTimeTokenHandler.mjs:43` |
| `data.user_id` | String | Id користувача, кожен код, що викликає, записує його рядком. | `services/web/app/src/Features/PasswordReset/PasswordResetHandler.mjs:27`, `services/web/app/src/Features/User/UserRegistrationHandler.mjs:117`, `services/web/modules/admin-tools/app/src/AdminUserManager.mjs:79` |
| `data.email` | String | Email користувача на момент створення токена. Скидання пароля шукає користувача за цим основним email (`PasswordResetHandler.mjs:66-70`). | як у `data.user_id` |
| `createdAt` | Date | Час створення. TTL-індекс видаляє токен через 90 днів. | `OneTimeTokenHandler.mjs:36,44` |
| `expiresAt` | Date | `createdAt` плюс `expiresIn` секунд: типово 1 година, 1 тиждень для посилання активації. Після цього пошуки ігнорують токен. | `OneTimeTokenHandler.mjs:35-37,45` |
| `peekCount` | Number | Скільки разів токен переглядали, не використовуючи. Кожен `peekValueFromToken` додає 1; при 4 (`MAX_PEEKS`) токен перестає працювати. | `OneTimeTokenHandler.mjs:8-31,107` |
| `usedAt` | Date | Час, коли токен використали або скасували. Пошуки ігнорують токен із цим полем. | `OneTimeTokenHandler.mjs:51-104` |

#### Призначення

| `use` | Функція | Строк дії | Код |
| - | - | - | - |
| `password` | Лист для скидання пароля зі сторінки «Забули пароль» | 1 година | `PasswordResetHandler.mjs:14-42` |
| `password` | Посилання активації: обліковий запис створюється з випадковим паролем, потім надходить посилання, щоб задати свій. Використовують публічна реєстрація (`services/web/modules/login-register/app/src/RegisterController.mjs:65`), сторінка реєстрації адміністратором з `user-activate` (`services/web/modules/user-activate/app/src/UserActivateController.mjs:27-30`) і скрипт `create-user` (`services/web/modules/server-ce-scripts/scripts/create-user.mjs:21`) | 1 тиждень | `UserRegistrationHandler.mjs:97-130` |
| `password` | Посилання активації або скидання пароля, надіслане з панелі адміністратора (модуль `admin-tools`) | 1 тиждень (активація), 1 година (скидання) | `AdminUserManager.mjs:76-103,196-206` |
| `email_confirmation` | Посилання підтвердження email. Лише читається: ніщо в цьому репозиторії більше не створює такі токени, бо підтвердження тепер надсилає 6-значний код (`services/web/app/src/Features/User/UserEmailsConfirmationHandler.mjs:15-35`) | | `UserEmailsConfirmationHandler.mjs:12,37-66` |

#### Хто записує

| Код | Що робить |
| - | - |
| `OneTimeTokenHandler.mjs:34-49` (`getNewToken`) | Вставляє токен. Викликають: `PasswordResetHandler.mjs:28`, `UserRegistrationHandler.mjs:115-119`, `AdminUserManager.mjs:77-81`. |
| `OneTimeTokenHandler.mjs:8-32` (`peekValueFromToken`) | Повертає `data` дійсного токена і додає 1 до `peekCount`. Використовується під час відкриття сторінки скидання пароля (`services/web/app/src/Features/PasswordReset/PasswordResetController.mjs:195-208`), повторно під час встановлення нового пароля (`PasswordResetHandler.mjs:94-96`) і під час підтвердження email (`UserEmailsConfirmationHandler.mjs:38-41`). |
| `OneTimeTokenHandler.mjs:75-88` (`expireToken`) | Встановлює `usedAt` для одного токена: після встановлення нового пароля (`PasswordResetHandler.mjs:44-48,119`) або підтвердження email (`UserEmailsConfirmationHandler.mjs:65`). |
| `OneTimeTokenHandler.mjs:90-104` (`expireAllTokensForUser`) | Встановлює `usedAt` для всіх відкритих токенів `password` користувача, коли користувач змінює пароль у налаштуваннях (`services/web/app/src/Features/User/UserController.mjs:146-149`) або адміністратор задає його в панелі адміністратора (`AdminUserManager.mjs:479-488`). |

#### Хто читає

| Код | Що робить |
| - | - |
| `PasswordResetHandler.mjs:50-70,94-119` | За токеном скидання або активації знаходить користувача, потім задає пароль. Сторінка активації з `user-activate` лише передає токен до цієї форми. |
| `UserEmailsConfirmationHandler.mjs:37-66` | Підтверджує email за токеном `email_confirmation` користувача, що увійшов. |
| `AdminUserManager.mjs:213-223` (module `admin-tools`) | Знаходить відкритий токен активації користувача, щоб знову показати посилання активації в панелі адміністратора. Читає `db.tokens` напряму. |

#### Індекси

| Назва | Ключі | Параметри | Міграція |
| - | - | - | - |
| `token_1_use_1` | `{ token: 1, use: 1 }` | унікальний | `20190912145031_create_tokens_indexes.mjs` |
| `createdAt_1` | `{ createdAt: 1 }` | TTL, `expireAfterSeconds: 7776000` (90 днів) | `20210407085118_token-expiry-with-ttl-index.mjs` |
| `data.user_id_1` | `{ "data.user_id": 1 }` | | `20231113173237_tokens_user_id_index.mjs` |

Міграції містяться в `tools/migrations/`.

#### Примітки

* Використаний або прострочений токен не видаляється одразу: він залишається з `usedAt` або минулим `expiresAt`, доки TTL-індекс не видалить його через 90 днів після `createdAt`.
* У `OneTimeTokenHandler` є також `getValueFromTokenAndExpire` (`OneTimeTokenHandler.mjs:51-73`), але його ніхто не викликає.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.