Перейти к содержанию

Настройка входа через GitHub в Trusted.ID#

📋 Эта инструкция входит в серию статей по настройке способов входа. Подробнее читайте в инструкции Способы входа и настройка виджета

В этом руководстве вы узнаете, как подключить аутентификацию с помощью аккаунта GitHub к системе Trusted.ID. Этот способ входа позволяет пользователям входить в приложения с помощью учётной записи сервиса GitHub.

Настройка входа через GitHub состоит из трёх ключевых этапов, которые выполняются в двух разных системах.


Шаг 1. Настройка приложения в GitHub#

Перед настройкой способа входа в Trusted.ID необходимо зарегистрировать ваше приложение в кабинете разработчика GitHub и получить ключи доступа:

  1. Перейдите в настройки GitHub по ссылке: https://github.com/settings/developers

  2. В разделе OAuth Apps нажмите New OAuth App.

  3. Заполните обязательные настройки приложения:

    • Application name - название приложения,
    • Homepage URL - адрес инсталляции сервиса,
    • Authorization callback URL - адрес в формате https://<адрес инсталляции>/api/interaction/code.

    Создание способа входа GitHub OAuth в кабинете разработчика сервиса

  4. Нажмите Register application.

  5. После создания приложения откройте его настройки и скопируйте:

    • Client ID
    • Client Secret (создаётся через кнопку Generate a new client secret)

    Создание способа входа GitHub OAuth в кабинете разработчика сервиса

Эти значения пригодятся на следующем шаге.


Шаг 2. Создание способа входа#

  1. Перейдите в кабинет администратора → вкладка Настройки.

    💡 Чтобы создать способ входа для организации, откройте кабинет организации. Если способ входа нужен для конкретного приложения, откройте настройки этого приложения.

  2. Найдите блок Способы входа и нажмите Настроить.

  3. В открывшемся окне нажмите кнопку Создать Кнопка Создать.
  4. Откроется окно со списком шаблонов.
  5. Выберите шаблон GitHub.
  6. Заполните форму создания:

    Основная информация

    • Имя — Название, которое увидят пользователи.
    • Описание (опционально) — Краткое описание.
    • Логотип (опционально) — Можно загрузить свою иконку, или будет использована стандартная.

    Параметры аутентификации

    • Идентификатор ресурса (client_id) — Вставьте скопированный ID Приложения (Client ID).
    • Секретный ключ (client_secret) — Вставьте скопированный Секрет (Client Secret).
    • Возвратный URL(Redirect URI) — Поле заполнится автоматически на основе вашего домена.

    Дополнительные настройки

    • Публичный способ входа — Включите, если хотите, чтобы этот способ входа можно было добавить в другие приложения системы (или организации), а также в профиль пользователя в качестве идентификатора внешнего сервиса.
    • Публичность — Настройте уровень публичности по умолчанию для идентификатора внешнего сервиса в профиле пользователя.
  7. Нажмите Создать.

После успешного создания новый способ входа появится в общем списке провайдеров.


Шаг 3. Добавление на виджет#

Чтобы пользователи увидели кнопку Войти через GitHub на форме авторизации, нужно активировать эту функцию в настройках виджета:

  1. В общем списке провайдеров найдите созданный способ входа.
  2. Включите переключатель на панели с провайдером.

Проверка: После сохранения откройте форму входа в тестовом приложении. На виджете должна появиться новая кнопка с логотипом GitHub.


Описание параметров#

Основная информация#

Название Описание Тип Ограничения
Имя Название, которое будет отображаться в интерфейсе сервиса Trusted.ID Текст Макс. 50 символов
Описание Краткое описание, которое будет отображаться в интерфейсе сервиса Trusted.ID Текст Макс. 255 символов
Логотип Изображение, которое будет отображаться в интерфейсе сервиса Trusted.ID и виджете входа JPG, GIF, PNG или WEBP Макс. размер: 1 МБ

Параметры аутентификации#

Название Параметр Описание
Идентификатор ресурса (client_id) Client_id ID приложения, созданного в GitHub
Секретный ключ (client_secret) Client_secret Сервисный ключ доступа приложения, созданного созданного в GitHub
Возвратный URL(Redirect URI) (не редактируемое) Redirect URI Адрес Trusted.ID, на который пользователь перенаправляется после аутентификации в стороннем сервисе

Дополнительные настройки#

Название Описание
Публичный способ входа При активации настройки:
- Способ входа станет доступен для добавления в другие приложения сервиса.
- Способ входа станет доступен для добавления в качестве идентификатора внешнего сервиса в профиле пользователя.
Публичность Задает уровень публичности по умолчанию для идентификатора внешнего сервиса в профиле пользователя

Смотрите также#

Для повышения удобства работы и хранения данных веб-сайт TRUSTED.RU использует файлы COOKIE. Продолжая работу с веб-сайтом, Вы даете свое согласие на работу с этими файлами.