Использование Google в качестве поставщика единого входа
 |
Важно |
| При использовании технологии единого входа (SSO) необходимо создать учетные записи пользователей в системе Документерра для каждого пользователя SSO, который авторизуется в стороннем сервисе. Это необходимо для того, чтобы система Документерра могла применять определенные права доступа к авторизованному пользователю. Эти права доступа настраиваются в профиле пользователя Документерры. REST API Документерры можно использовать для массового создания пользователей или для создания нового пользователя Документерры каждый раз, когда с вашей стороны создается новый пользователь приложения. | |
Вы можете войти в систему Документерра, используя Google в качестве поставщика OpenID Connect. Далее приведены инструкции по настройке веб-приложения Google и настройке портала Документерры для использования данного поставщика OpenID Connect.
Настройка веб-приложения Google
Прежде всего, чтобы настроить веб-приложение Google, вам необходимо зарегистрировать портал в системе Документерра в качестве веб-приложения в консоли Google Developer Console. Затем, когда вы открываете консоль в первый раз, она просит вас создать новый проект.
- Укажите имя нового проекта и нажмите Создать:
- После создания нового проекта откройте экран API и сервисов и нажмите Учетные данные, чтобы продолжить настройку.
- На экране Учетные данные нажмите кнопку Создать учетные данные и выберите опцию идентификатора клиента OAuth client ID.
- Следующий шаг — настройка экрана подтверждения, отвечающего за то, что должно отображаться на экране входа Google при входе в только что созданный вами проект. Данный шаг необязателен, если вы уже настроили экран подтверждения. Нажмите кнопку Настроить экран подтверждения:
- Выберите подходящий вам тип пользователя:
- Укажите имя приложения, адрес электронной почты ответственного лица, список авторизованных доменов и некоторые другие дополнительные параметры, если необходимо.
- Требуется авторизованный домен documenterra.co. Если вы настроили собственный домен для своего портала, возможно, вам также потребуется добавить этот домен в список.
- На следующем шаге вы можете добавить или удалить области. Во-первых, убедитесь, что список Областей определения для Google API содержит области электронной почты и openid.
- Вы можете сгенерировать идентификатор клиента и секрет клиента для приложения, когда установлен экран подтверждения. Для этого укажите тип приложения как веб-приложение, введите внутреннее имя приложения и укажите URL-адрес перенаправления авторизации приложения. Оно должно быть следующим (обязательна косая черта в конце):https://<YOU_PORTAL_NAME>.documenterra.co/oauth2/
Google сгенерирует для вас идентификатор клиента и секреты:
Чтобы перейти к настройкам Документерры, нам нужно получить авторизацию и URL-адреса токенов от Google. Этот шаг можно пропустить, если вы настраиваете заранее заданного поставщика Google в системе Документерра. Чтобы получить эти значения, нажмите кнопку Скачатьрядом с именем только что созданного приложения и скачайтефайл JSON, содержащий все необходимые данные.
Настройка Документерры
Теперь давайте настроим Документерру для работы с Google в качестве поставщика OpenID Connect. Выполните следующие действия:
- Чтобы портал Документерра работал с поставщиком OpenID Connect, нам необходимо зарегистрировать клиента на портале. Это может сделать пользователь с правами администратора в редакторе настроек портала:
- Откройте страницу Технология единого входа в меню Администрирование, выберите предопределенное подключение с помощью Google, укажите идентификатор клиента и секрет клиента, полученные от Google ранее. Включите подключение и нажмите «Сохранить», чтобы сохранить настройки.
- После сохранения настроек подключения вы можете указать данного поставщика в качестве поставщика по умолчанию. Для этого выберите имя клиента в поле Войти с помощью.
Вот и все, на портале включена функциональность OpenID Connect для Google! - Если вы хотите продолжить использовать диалоговое окно входа Документерры, оставьте поле Войти с помощью без изменений. Вы сможете войти на портал, используя учетные данные Google в диалоговом окне «Войти», нажав соответствующую кнопку:
Использование Google в качестве поставщика OpenID
Чтобы проверить, как работает автоматическая авторизация через OpenID Connect, нам необходимо убедиться, что у нас есть пользователь с адресом электронной почты, соответствующим действующей учетной записи Google.
- Давайте откроем страницу управления пользователями:
- Добавьте нового пользователя с адресом, привязанным к действующему аккаунту Google:
- После создания пользователя выйдите из своей учетной записи администратора или откройте новое окно браузера в режиме инкогнито. Кроме того, убедитесь, что с тестовой учетной записи Google не было входа в этот сеанс браузера. Вы можете открыть страницу Google+, чтобы убедиться, что с учетных записей Google не было входа в систему.
Предположим, вы указали Google в качестве варианта входа по умолчанию. В этом случае вы можете открыть страницу из публикации с ограниченным доступом по прямой ссылке, которая может быть ссылкой на ваш портал или приложение в качестве ссылки на страницу справки, статью с часто задаваемыми вопросами и т.д. Вы будете автоматически перенаправлены на страницу входа в учетную запись Google, так как на данный момент вы еще не вошли в Google.
После ввода действительных учетных данных вы войдете в систему Документерра.
-
Теперь выйдите из Документерры и снова откройте эту страницу. Поскольку в этом сеансе браузера вы вошли в систему Google, Документерра автоматически войдет в систему без подсказок для входа.
Если вы хотите, чтобы поставщик OpenID Connect всегда показывал подсказку для входа в систему, вы можете изменить параметр Поведение при входе в систему на Запрос подсказки для входа:
На этот раз, если вы вошли в систему Google, при входе в систему Документерра вы по-прежнему видите подсказку Google:
-
Даже если вы указали Google в качестве варианта входа по умолчанию, войти на портал Документерры все еще возможно, используя собственные учетные данные (учетная запись пользователя Документерры, без единого входа). Вы можете сделать это, перейдя по ссылке «Войти» со специальным параметром no-sso: https://<YourPortalName>.documenterra.co/login/?error=no&no-sso=true
Отлично! Вы успешно настроили Google в качестве поставщика OpenID Connect для своего портала онлайн-документации.