Настройка поставщика аутентификации | On‑Premise | 2GIS Documentation

Настройка внешнего поставщика аутентификации

Чтобы работать с продуктами 2ГИС Про и 2ГИС Линза, конечные пользователи должны проходить аутентификацию. Программный комплекс 2ГИС не предоставляет готовый сервис аутентификации для установки в закрытом контуре. Поэтому вам нужно использовать собственного поставщика OpenID Connect (OIDC) для авторизации пользователей по технологии единого входа (SSO).

Аутентифицироваться и авторизоваться в 2ГИС Про и 2ГИС Линзе могут только те пользователи, которые зарегистрированы в базе внешнего поставщика OIDC. Управление пользователями также осуществляется на стороне этого поставщика.

Настройте поставщика OIDC, выполнив следующие условия:

  1. Определите обязательные утверждения (claims) о данных пользователя. Следующие данные гарантированно должны быть заполнены в ответе user-info:

    • sub — идентификатор пользователя.
    • email — email пользователя.
    • email_verified — флаг, указывающий на то, был ли email подтверждён пользователем.
    • name — полное имя пользователя.
    • phone_number — номер телефона пользователя.
  2. Настройте области видимости (scopes), по которым можно получать заданные утверждения (claims). Стандартно используются следующие scopes:

    • openid — обязательный параметр, указывающий на использование OpenID Connect для аутентификации пользователя.
    • email — email пользователя.
    • profile — ссылка на профиль пользователя.
    • phone — номер телефона пользователя.
  3. Создайте клиента в вашем поставщике OIDC:

    1. Настройте идентификатор (client_id) и cекрет (client_secret) клиента.

    2. Укажите Callback URL и Logout URL для каждого сервиса:

      • 2ГИС Про:

        • Callback URL: https://{application_host}/api/auth/code
        • Logout URL: https://{application_host}/api/auth/after_sign_out_openid
      • 2ГИС Линза (CityLens Web):

        • Callback URL: https://{application_host}/kc/callback
        • Logout URL: https://{application_host}/
      • 2ГИС Линза (CityLens Routes UI):

        • Callback URL: https://{application_host}/auth
        • Logout URL: https://{application_host}
    3. Настройте работу клиента с заданными на предыдущем шаге scopes.