Інтеграція з Authentik

Матеріал з Planfix

Інтеграція з authentik дозволяє співробітникам вашої компанії входити в Planfix з використанням єдиного пароля через Single Sign-On (SSO). Це спрощує авторизацію, підвищує безпеку та допомагає централізовано керувати доступом співробітників.

Підтримувані функції

  • Ініційований IdP вхід (SSO)
  • Ініційований SP вхід
  • Just-In-Time (JIT) створення користувачів
  • SCIM Provisioning

Функції SCIM Provisioning

  • Створення користувачів
  • Оновлення даних користувачів
  • Деактивація користувачів

Налаштування Single Sign-On (SSO)

Кроки в Planfix

  1. Перейдіть у розділ Керування акаунтом - Інтеграції - Single Sign-On.
  2. Активуйте інтеграцію з authentik.
  3. Залиште відкрите вікно налаштувань інтеграції: з нього знадобляться значення Audience, ACS URL (Assertion Consumer Service), SCIM URL та SCIM Token.

Кроки в Authentik

  1. Відкрийте адміністративну панель authentik.
  2. Перейдіть у Applications - Applications.
  3. Натисніть New Application.
  4. Вкажіть дані застосунку, наприклад:
    • Name: Planfix
    • Slug: planfix
  5. На кроці вибору провайдера оберіть SAML Provider.
  6. В налаштуваннях SAML-провайдера вкажіть значення з вікна інтеграції в Planfix:
Поле в authentik Значення
ACS URL Скопіюйте ACS URL (Assertion Consumer Service) з Planfix
Audience Скопіюйте Audience з Planfix
  1. Створіть застосунок і провайдера.
  2. У налаштуваннях провайдера на вкладці Metadata скопіюйте URL метаданих SAML-провайдера authentik.

Кроки в Planfix

  1. Поверніться в налаштування інтеграції з authentik в Planfix.
  2. У полі Metadata URI вкажіть URL метаданих SAML-провайдера authentik:
https://<authentik-domain>/application/saml/<application-slug>/metadata/

Наприклад:

https://auth.example.com/application/saml/planfix/metadata/
  1. Збережіть налаштування.

Тепер на сторінці входу в Planfix буде доступна авторизація через authentik. Під час першого входу нового користувача його обліковий запис у Planfix буде створено автоматично за допомогою механізму JIT Provisioning.

Налаштування SCIM Provisioning

SCIM Provisioning потрібен, якщо потрібно автоматично створювати, оновлювати та деактивувати співробітників в Planfix на основі даних з authentik.

Кроки в authentik

  1. Перейдіть у Applications - Providers.
  2. Створіть новий provider типу SCIM Provider.
  3. У налаштуваннях SCIM-провайдера вкажіть:
Поле в authentik Значення
SCIM Base URL SCIM URL з налаштувань Planfix
Authentication Mode Token
Token SCIM Token з налаштувань Planfix
  1. Відкрийте застосунок Planfix в authentik.
  2. У полі Backchannel Providers додайте створений SCIM-провайдер.
  3. Збережіть зміни.

Після налаштування authentik буде синхронізувати користувачів з Planfix. Переконайтеся, що користувачі, яких потрібно передавати в Planfix, мають доступ до застосунку Planfix в authentik.

Перевірка інтеграції

  1. Переконайтеся, що в Planfix активована інтеграція SSO з authentik.
  2. Переконайтеся, що в authentik створено застосунок Planfix з SAML-провайдером.
  3. Перевірте, що ACS URL і Audience в authentik співпадають зі значеннями з Planfix.
  4. Перевірте, що в Planfix вказано коректний Metadata URI authentik.
  5. Призначте користувачу доступ до застосунку Planfix в authentik.
  6. Виконайте вхід в Planfix через authentik.
  7. Якщо використовується SCIM, перевірте створення або оновлення користувача в Planfix після синхронізації.

Важливо

  • При ввімкненій опції Тільки SSO аутентифікація співробітники зможуть входити в акаунт лише через SSO, окрім співробітників зі списку винятків та керуючого акаунтом.
  • Якщо SCIM Provisioning не ввімкнено, деактивація користувача в authentik не деактивує співробітника в Planfix автоматично. У цьому випадку співробітника потрібно деактивувати вручну.
  • Під час створення співробітника через JIT Provisioning або SCIM Provisioning, якщо в пакеті досягнуто ліміту співробітників, підписка буде автоматично розширена за рахунок зменшення загального оплаченого строку підписки акаунта.
  • Якщо співробітника деактивовано через SCIM Provisioning, кількість оплачених додаткових місць у підписці автоматично зменшується.

Перейти