Установка приложения OAuth в организации - GitHub Enterprise Cloud Docs

OAuth (Open Authorization) - это открытый протокол, который позволяет пользователям предоставлять доступ к своей информации третьим сторонам без передачи им своих учетных данных. Приложение, использующее OAuth, может получить доступ к данным пользователя, только если пользователь дает на это разрешение.
Установка приложения OAuth в организации на платформе GitHub Enterprise Cloud позволяет организации авторизовать доступ к своим репозиториям, командам и другим данным через OAuth-токены. Это удобно для интеграции сторонних сервисов с GitHub и обеспечения безопасности доступа к данным организации.
Чтобы установить приложение OAuth в организации на платформе GitHub Enterprise Cloud, нужно выполнить несколько шагов. Сначала необходимо создать приложение в GitHub, затем настроить разрешения и ограничения приложения, и, наконец, настроить доступ к репозиториям и командам организации через OAuth-токены. Детальная информация о каждом шаге установки приложения OAuth в организации на платформе GitHub Enterprise Cloud представлена в данной статье.
Примечание: Перед установкой приложения OAuth в организации необходимо удостовериться, что у вас есть права администратора организации на платформе GitHub Enterprise Cloud.
Установка OAuth приложения на GitHub Enterprise Cloud
GitHub Enterprise Cloud позволяет организациям создавать и использовать приложения с помощью протокола OAuth. OAuth позволяет пользователям авторизовывать третьесторонние приложения для доступа к их аккаунту на GitHub. В этом разделе описан шаг за шагом процесс установки OAuth приложения на GitHub Enterprise Cloud.
Шаг | Описание |
---|---|
1 | Откройте страницу настройки вашего организационного профиля в GitHub Enterprise Cloud. |
2 | Перейдите на вкладку "OAuth приложения" и нажмите кнопку "Новое OAuth приложение". |
3 | Задайте название приложения, его описание и введите домен, на котором будет развернуто приложение. |
4 | Выберите разрешения, которые приложение будет запрашивать у пользователей. Рекомендуется начать с минимально необходимого набора разрешений. |
5 | Введите URL для обратного вызова, на который будут отправляться авторизационные коды. Этот URL должен быть доступен из сети. |
6 | Нажмите кнопку "Зарегистрировать приложение". |
7 | Получите и сохраните "Client ID" и "Client Secret" - это ваши учетные данные для использования OAuth API. |
8 | Используйте учетные данные "Client ID" и "Client Secret" для настройки вашего OAuth приложения на сервере. |
После успешной установки и настройки OAuth приложения, вы сможете использовать его для авторизации пользователей через API и взаимодействия с их аккаунтами в GitHub Enterprise Cloud.
Шаг 1: Регистрация приложения
Для установки приложения OAuth в вашей организации GitHub Enterprise Cloud необходимо выполнить следующие шаги:
- Откройте страницу Настройки разработчика в своей организации GitHub.
- Нажмите кнопку "Зарегистрировать новое приложение".
- Заполните поля "Имя приложения" и "URL авторизации". Имя приложения может быть произвольным, это имя будет отображаться при запросе авторизации пользователя. В поле "URL авторизации" укажите URL адрес, который будет использоваться для авторизации пользователей вашего приложения.
- Выберите тип приложения - "Веб" или "Мобильное". В случае выбора "Веб" укажите домен вашего приложения в поле "URL авторизации". В случае выбора "Мобильное" укажите "Адрес перенаправления OAuth".
- Укажите разрешения, которые ваше приложение будет запрашивать у пользователей GitHub. Например, доступ к учетной записи, право на чтение репозиториев и другие. Выберите нужные разрешения из предложенного списка.
- Нажмите кнопку "Зарегистрировать приложение".
После регистрации приложения вам будут предоставлены Client ID и Client Secret - уникальные идентификаторы вашего приложения. При необходимости, сохраните их для использования при дальнейшей настройке.
Перейдите к следующему шагу для настройки вашего приложения OAuth в организации GitHub Enterprise Cloud.
Шаг 2: Настройка на стороне организации
После установки приложения OAuth на вашем сервере GitHub Enterprise Cloud, необходимо выполнить несколько дополнительных настроек на стороне вашей организации:
- Зайдите в настройки организации на GitHub Enterprise Cloud.
- Выберите вкладку "OAuth приложения".
- Нажмите кнопку "Настроить OAuth приложение".
- Введите название приложения, которое будет отображаться для пользователей при авторизации через OAuth.
- Укажите URL-адрес вашего сервера OAuth. Этот URL-адрес будет использоваться GitHub для перенаправления пользователей после успешной авторизации.
- Укажите URL-адрес страницы с информацией о приложении для пользователей.
- Выберите необходимые разрешения для приложения. Разрешения определяют, какие операции на сервере GitHub будет разрешено выполнять приложению OAuth.
- Нажмите кнопку "Добавить приложение", чтобы сохранить настройки.
После выполнения этих шагов, ваше приложение OAuth будет готово к использованию в вашей организации. Вы можете предоставить пользователям ссылку для авторизации через OAuth и начать использовать его функциональность.
Настройка GitHub Enterprise Cloud Docs
Для настройки GitHub Enterprise Cloud Docs в организации необходимо выполнить следующие шаги:
- Войдите в аккаунт администратора организации в GitHub.
- Перейдите на вкладку "Settings" (Настройки) вашей организации.
- Выберите вкладку "Security" (Безопасность).
- Прокрутите страницу вниз до раздела "OAuth Apps" (Приложения OAuth).
- Нажмите кнопку "New OAuth App" (Создать приложение OAuth).
- Заполните поле "Application name" (Название приложения) и "Homepage URL" (URL домашней страницы) для вашего приложения.
- Укажите URL-адрес авторизации "Authorization callback URL" (URL обратного вызова авторизации).
- Выберите необходимые разрешения для вашего приложения.
- Нажмите кнопку "Register application" (Зарегистрировать приложение).
- Скопируйте и сохраните Client ID и Client Secret вашего приложения.
После успешной настройки и регистрации приложения OAuth, вы сможете использовать его в своей организации для авторизации и аутентификации пользователей.
Шаг 3: Добавление приложения в GitHub
В этом шаге вам необходимо добавить ваше приложение в GitHub, чтобы получить необходимые данные для настройки аутентификации OAuth.
1. Войдите в ваш аккаунт на GitHub и перейдите на страницу настроек вашей организации.
2. В меню слева выберите "Настройки" и перейдите на вкладку "OAuth приложения".
3. Нажмите на кнопку "Зарегистрировать новое приложение".
4. Введите название приложения и домен приложения. Домен приложения должен быть доступен из Интернета и вести на ваш сервер с установленным приложением OAuth.
5. Укажите URL коллбэка, который будет использоваться для перенаправления обратно из GitHub после успешной аутентификации. В зависимости от ваших настроек сервера, URL коллбэка может иметь следующий формат: https://example.com/callback
.
6. Укажите домен настройки OAuth, который будет использоваться для привязки других приложений к вашему OAuth. Введите его в формате: https://example.com
.
7. Укажите область видимости для вашего приложения. Область видимости определяет, какие ресурсы GitHub пользователь сможет просматривать и редактировать через ваше приложение. Выберите только необходимые права доступа для вашего приложения.
8. После заполнения всех полей, нажмите на кнопку "Зарегистрировать приложение".
9. После регистрации приложения вы получите идентификатор клиента и секретный ключ приложения. Сохраните эти данные в безопасном месте, так как они понадобятся для настройки аутентификации OAuth в вашем приложении.
Поздравляем! Вы успешно зарегистрировали приложение в GitHub и получили необходимые данные для настройки аутентификации OAuth.
Шаг 4: Настройка прав доступа и ограничений
После установки и настройки приложения OAuth в организации GitHub Enterprise Cloud необходимо произвести настройку прав доступа и ограничений для пользователя или команды, которым будет предоставлен доступ к приложению.
Вы можете управлять доступом и ограничениями через вкладку "Настройки" в профиле пользователя или команды. Вам будет предоставлен список доступных прав и ограничений, которые можно выбрать и настроить в соответствии с потребностями вашего проекта.
Права доступа могут включать возможность чтения, записи, создания и удаления репозиториев и других объектов в GitHub Enterprise Cloud. Ограничения могут включать ограничение доступа к определенным репозиториям, веткам, комментариям и задачам.
Обратите внимание, что права и ограничения, установленные для пользователя или команды, будут применяться только к использованию приложения OAuth. Пользователи могут иметь различные права и ограничения для других действий и операций в GitHub Enterprise Cloud.
Перед тем как устанавливать права доступа и ограничения для пользователя или команды, рекомендуется ознакомиться с руководством по безопасности и документацией GitHub Enterprise Cloud для более детальной информации о настройке и управлении правами доступа.
- Выберите вкладку "Настройки" в профиле пользователя или команды.
- Настройте права доступа и ограничения в соответствии с потребностями вашего проекта.
- Сохраните изменения.
После настройки прав доступа и ограничений для пользователя или команды, они смогут полноценно использовать приложение OAuth в GitHub Enterprise Cloud в соответствии с установленными правами и ограничениями.
Вопрос-ответ:
Что такое приложение OAuth и зачем оно нужно в организации GitHub Enterprise Cloud?
Приложение OAuth - это способ авторизации и аутентификации пользователей в организации GitHub Enterprise Cloud. Оно позволяет организовать безопасную и удобную авторизацию через сторонние сервисы или приложения. Приложение OAuth обеспечивает высокую степень защиты данных и контроля доступа к ресурсам организации.
Можно ли установить несколько приложений OAuth в одной организации GitHub Enterprise Cloud?
Да, можно установить несколько приложений OAuth в одной организации GitHub Enterprise Cloud. Это может быть полезно, если у вас есть различные сервисы или приложения, которые требуют разных настроек авторизации и аутентификации. Установив несколько приложений OAuth, вы сможете контролировать доступ к каждому из них и настраивать их независимо друг от друга.