ЕСОЗ - публічна документація
[RC] [DRAFT] BP-ESOZ-025-0016 [APIS] Авторизація користувача ДІЯ
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою.
Властивості документа
Тип документа | Бізнес-процес |
---|---|
Назва документа | BP-ESOZ-025-0016 [APIS] Авторизація користувача ДІЯ |
ID настанови | GUI-004 |
Автор | @Liudmyla Dobrovolska (SoE eHealth) |
Версія документа | v010 |
Статус документа | DRAFT |
Дата створення | 01.10.2024 |
Дата оновлення |
|
ID групи | BPG-ESOZ-025 |
ID бізнес-процесу | BP-ESOZ-025-0016 |
Назва бізнес-процесу | [APIS] Авторизація користувача ДІЯ |
Посилання на схеми |
Загальні відомості
Процес авторизації користувача полягає в наданні доступу до Системи на основі перевірки прав доступу користувача. Авторизація здійснюється після успішної автентифікації користувача, яка підтверджує його особу
Передумови
Користувач АПІС має бути попередньо зареєстрований в Системі
Перед початком авторизації АПІС має надати користувачу можливість ознайомитися з політикою конфіденційності АПІС:
посилання на політику конфіденційності АПІС повинно дозволяти користувачу ознайомитися з нею. АПІС має дозволяти користувачу зберегти текст політики як файл або надіслати його на електронну пошту обрану користувачем;
КПІС повинна забезпечити, що користувач може продовжити роботу з Системою лише після явної згоди з положеннями політики конфіденційності АПІС
Схема бізнес-процесу
Зображення схеми
Посилання на схему
На перегляд: https://modeler.camunda.io/share/ad105083-14a2-49ab-ae45-2f9912d58bc1
На редагування: https://modeler.camunda.io/diagrams/82e4c5bc-f926-406b-9ea0-00b15c52ff56--bp-esoz-025-0016-apis-авторизація-користувача-дія?v=1214,779,1
Похідний файл схеми (BPMN)
Опис кроків по процесу
1 | № кроку | Крок | Опис | Технічний модуль | Методи API які мають або можуть бути використані |
2 | SE 1.10 | Початок процесу | Користувач бажає авторизоватись в Системі |
|
|
3 | 1.10 | Користувач ініціював авторизацію у Системі | Користувач:
АПІС розпочинає процес авторизації пацієнта в ЕСОЗ. в ЕСОЗ |
|
|
4 | 1.20 | Відобразити форму для погодження переліку скоупів | АПІС повинна відобразити користувачу форму для погодження переліку скоупів для отримання АПІС |
|
|
5 | 1.30 | Переглянути форму для надання скоупів | Користувач:
|
|
|
6 | GW 1.10 | Запит на надання доступу відхилено? |
|
|
|
7 | 1.40 | Зупинити процес авторизації | АПІС повинна зупинити процес авторизації, у разі відхилення користувачем надання доступу до переліку скоупів |
|
|
8 | 1.50 | Повернути користувача на початок процесу авторизації | Після зупинення процесу авторизації, АПІС повинна повернути користувача на початок процесу авторизації, перейти до кроку 1.10 |
|
|
9 | 1.60 | Отримати дані для авторизації | У разі погодження користувачем надання АПІС доступу до переліку скоупів, АПІС повинна отримати дані для авторизації, які будуть підписані користувачем | Scope - Resource - POST /oauth/nonce | |
10 | 2.10 | Get nonce | В ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом АРІ |
| |
11 | 1.70 | Підписати дані для авторизації за допомогою ЕП | АПІС:
Користувач підписує дані для авторизації за допомогою ЕП |
|
|
12 | 1.80 | Передати підписані дані до Системи | Після підписання користувачем даних для авторизації за допомогою ЕП, АПІС повинна передати підписані дані до Системи | Scope - trusted_person:login Resource - POST /api/pis/sign-in | |
13 | 2.20 | TRUSTED PIS. Patient sign-in | В ЦБД ЕСОЗ виконуються дії, передбачені відповідним методом АРІ |
| |
14 | GW 1.20 | Підписні дані коректні? |
|
|
|
15 | 1.90 | Зупинити процес авторизації | У випадку отримання від Системи помилки некоректних даних, АПІС повинна зупинити процес авторизації і відобразити відповідне повідомлення про помилку авторизації |
|
|
16 | 1.100 | Інформаційне повідомлення користувачу про помилку | АПІС відображає повідомлення користувачу з посиланням на помилкову сутність |
|
|
17 | EE 1.10 | Процес завершено | Процес авторизації завершується через отримання помилки під час авторизації |
|
|
18 | GW 1.30 | Знайдено активного запису про пацієнта? |
|
|
|
19 | 1.110 | Зупинити процес авторизації | АПІС повинна зупинити процес авторизації у разі відсутності активного запису про пацієнта на основі даних з ЕП |
|
|
20 | 1.120 | Інформаційне повідомлення користувачу про необхідність зареєструватись | АПІС відображає повідомлення користувачу з пропозицією перейти до процедури реєстрації в ЕСОЗ |
|
|
21 | EE 1.20 | Процес завершено | Процес авторизації завершується через відсутність активного запису про пацієнта |
|
|
22 | GW 1.40 | Знайдено більше одного активного запису про пацієнта? |
|
|
|
23 | 1.130 | Зупинити процес авторизації | АПІС повинна зупинити процес авторизації у разі якщо знайдено більше одного активного запису про пацієнта |
|
|
24 | 1.140 | Інформаційне повідомлення користувачу: "Звернутись до НЦЗУ за уточненням персональних даних" | АПІС відображає повідомлення користувачу з пропозицією звернутись до НЦЗУ за уточненням персональних даних |
|
|
25 | EE 1.30 | Процес завершено | Процес авторизації завершується через виявлення більш ніж одного активного запису про пацієнта |
|
|
26 | 1.150 | Зберегти токен доступу “access token” та токен оновлення доступу “refresh token” | У разі успішної авторизації, АПІС повинна зберегти токен доступу ("access token") та токен оновлення доступу ("refresh token") |
|
|
27 | 1.160 | Відображена головна сторінка КП | Користквас отримує повідомлення про успішну авторизацію |
|
|
28 | EE 1.40 | Процес завершено користувач авторизований | Користувач успішно авторизований в Системі |
|
|
Бізнес правила
Авторизація користувача можлива лише після успішної автентифікації, під час якої система перевіряє його автентифікаційні дані
Після автентифікації користувачу надається доступ до Системи відповідно до його ролі, що визначає набір скоупів для доступу до Системи
Користувач отримує токен доступу з обмеженим терміном дії, що надає тимчасовий доступ до системи
Якщо термін дії токена або сесії закінчується, користувач повинен пройти повторну автентифікацію для поновлення доступу
У разі невдалої авторизації система інформує користувача про помилку через відповідне повідомлення
Результат процесу
Результатом процесу авторизації користувача є надання йому токена доступу ("access token") та токена оновлення доступу ("refresh token"). Ці токени дозволяють користувачу отримати доступ до системних ресурсів відповідно до його ролі. Користувач може взаємодіяти лише з тими даними та функціями, до яких йому надано дозволи на основі його прав доступу
Перелік змін
Версія документа | Опис змін | Номер релізу | |
---|---|---|---|
1 |
|
|
|
2 |
|
|
|
ЕСОЗ - публічна документація