Сведения параметрах URL-адреса GitHub App
Вы можете добавить параметры запроса к этим URL-адресам, чтобы предварительно выбрать конфигурацию GitHub App в личной учетной записи или учетной записи организации:
- Личная учетная запись:
https://github.com/settings/apps/new - Учетная запись организации:
https://github.com/organizations/:org/settings/apps/new
Пользователь, создающий приложение, может изменить предварительно выбранные значения на странице регистрации GitHub App перед отправкой приложения. Если вы не включите обязательные параметры в строку запроса URL-адреса, например name, пользователь, создающий приложение, должен будет ввести значение перед отправкой приложения.
Для приложений, которым требуется секрет для защиты веб-перехватчика, значение секрета должно быть установлено в форме пользователем, создающим приложение, а не с помощью параметров запроса. Дополнительные сведения см. в разделе Обеспечение безопасности веб-перехватчиков.
Следующий URL-адрес создает новое общедоступное приложение с именем octocat-github-app с предварительно настроенным описанием и URL-адресом обратного вызова. Этот URL-адрес также выбирает разрешения на чтение и запись для checks, подписывается на события веб-перехватчика check_run и check_suite, а также выбирает вариант запроса авторизации пользователя (OAuth) во время установки:
https://github.com/settings/apps/new?name=octocat-github-app&description=An%20Octocat%20App&callback_urls[]=https://example.com&request_oauth_on_install=true&public=true&checks=write&events[]=check_run&events[]=check_suite
Полный список доступных параметров запроса, разрешений и событий приведен в разделах ниже.
Параметры конфигурации GitHub App
| Имя | Тип | Описание |
|---|---|---|
name | string | Имя GitHub App. Присвойте своему приложению краткое и понятное имя. Это имя должно отличаться от имени существующего пользователя GitHub, если только это не ваше собственное имя пользователя или организации. Краткая версия имени вашего приложения будет отображаться в пользовательском интерфейсе, когда ваша интеграция выполнит действие. |
description | string | Описание GitHub App. |
url | string | Полный URL-адрес домашней страницы сайта GitHub App. |
callback_urls | array of strings | Полный URL-адрес для перенаправления после авторизации установки. Вы можете указать до 10 URL-адресов обратного вызова. Эти URL-адреса будут использоваться, если вашему приложению необходимо идентифицировать и авторизовать запросы от пользователя к серверу. Например, callback_urls[]=https://example.com&callback_urls[]=https://example-2.com. |
request_oauth_on_install | boolean | Если ваше приложение выполняет авторизацию пользователей с помощью потока OAuth, вы можете установить для этого параметра значение true. Это позволит пользователям авторизовать приложение при его установке, уменьшив количество шагов. Если вы выберете этот вариант, setup_url станет недоступным и пользователи будут перенаправлены на ваш callback_url после установки приложения. |
setup_url | string | Полный URL-адрес для перенаправления после установки GitHub App, если для приложения требуется дополнительная настройка после установки. |
setup_on_update | boolean | Задайте значение true, чтобы перенаправлять людей на URL-адрес настройки при обновлении установок, например после добавления или удаления репозиториев. |
public | boolean | Задайте значение true, если приложение GitHub App доступно для всех пользователей, или false — если оно доступно только владельцу. |
webhook_active | boolean | Задайте значение false, чтобы отключить веб-перехватчик. Веб-перехватчик включен по умолчанию. |
webhook_url | string | Полный URL-адрес, на который вы хотите отправлять полезные данные события веб-перехватчика. |
events | array of strings | События веб-перехватчика. Для некоторых событий веб-перехватчика необходимо получить разрешения read или write для ресурса, прежде чем выбрать событие при регистрации нового GitHub App. Сведения о доступных событиях и необходимых для них разрешениях см. в разделе События веб-перехватчика GitHub App. Вы можете выбрать несколько событий в строке запроса. Например, events[]=public&events[]=label. |
single_file_name | string | Это узкоспециализированное разрешение, позволяющее приложению получать доступ к одному файлу в любом репозитории. При задании разрешения read или write для single_file в этом поле указывается путь к одному файлу, которым будет управлять GitHub App. Если вам нужно управлять несколькими файлами, см. single_file_paths ниже. |
single_file_paths | array of strings | Этот параметр позволяет приложению получить доступ к десяти указанным файлам в репозитории. При задании разрешения read или write для single_file этот массив может хранить пути до десяти файлов, которыми будет управлять GitHub App. Все эти файлы получают одно и то же разрешение, заданное single_file, и не имеют отдельных индивидуальных разрешений. При настройке двух или более файлов API возвращает multiple_single_files=true, в противном случае возвращается multiple_single_files=false. |
Разрешения GitHub App
Вы можете выбрать разрешения в строке запроса, используя имя разрешения из приведенной ниже таблицы в качестве имени параметра запроса и тип разрешения в качестве значения запроса. Например, чтобы выбрать разрешения Read & write в пользовательском интерфейсе для contents, в строке запроса нужно указать &contents=write. Чтобы выбрать разрешения Read-only в пользовательском интерфейсе для &blocking=read, в строке запроса нужно указать blocking. Чтобы выбрать no-access в пользовательском интерфейсе для checks, ваша строка запроса не должна содержать разрешение checks.
| Разрешение | Описание |
|---|---|
administration | Предоставляет доступ к различным конечным точкам для администрирования организации и репозитория. Это может быть none, read или write. |
blocking | Предоставляет доступ к API блокирования пользователей. Это может быть none, read или write. |
checks | Предоставляет доступ к API проверок. Это может быть none, read или write. |
contents | Предоставляет доступ к различным конечным точкам, которые позволяют изменять содержимое репозитория. Это может быть none, read или write. |
deployments | Предоставляет доступ к API развертываний. Это может быть none, read или write. |
emails | Предоставляет доступ к API сообщений электронной почты. Это может быть none, read или write. |
followers | Предоставляет доступ к API подписчиков. Это может быть none, read или write. |
gpg_keys | Предоставляет доступ к API ключей GPG. Это может быть none, read или write. |
issues | Предоставляет доступ к API проблем. Это может быть none, read или write. |
keys | Предоставляет доступ к API открытых ключей. Это может быть none, read или write. |
members | Предоставляет доступ для управления участниками организации. Это может быть none, read или write. |
metadata | Предоставляет доступ к конечным точкам только для чтения, которые не допускают утечки конфиденциальных данных. Может иметь значение read или none. Если вы устанавливаете для GitHub App какое-либо разрешение, по умолчанию задается значение read. Если же вы не указываете никаких разрешений, по умолчанию задается значение none. |
organization_administration | Предоставляет доступ к конечной точке Обновление организации и API ограничений взаимодействия с организацией. Это может быть none, read или write. |
organization_hooks | Предоставляет доступ к API веб-перехватчиков организации. Это может быть none, read или write. |
organization_plan | Предоставляет доступ для получения сведений о плане организации с помощью конечной точки Получение организации. Это может быть none или read. |
organization_projects | Предоставляет доступ к API проектов. Это может быть none, read, write или admin. |
organization_user_blocking | Предоставляет доступ к API блокирования пользователей организации. Это может быть none, read или write. |
pages | Предоставляет доступ к API страниц. Это может быть none, read или write. |
plan | Предоставляет доступ для получения сведений о плане GitHub пользователя с помощью конечной точки Получение пользователя. Это может быть none или read. |
pull_requests | Предоставляет доступ к различным конечным точкам запросов на вытягивание. Это может быть none, read или write. |
repository_hooks | Предоставляет доступ к API веб-перехватчиков репозитория. Это может быть none, read или write. |
repository_projects | Предоставляет доступ к API проектов. Это может быть none, read, write или admin. |
security_events | Предоставляет доступ к API сканирования кода. Это может быть none, read или write. |
single_file | Предоставляет доступ к API содержимого. Это может быть none, read или write. |
starring | Предоставляет доступ к API пометки звездочкой. Это может быть none, read или write. |
statuses | Предоставляет доступ к API состояний. Это может быть none, read или write. |
team_discussions | Предоставляет доступ к API обсуждений в команде и API комментария к обсуждению в команде. Это может быть none, read или write. |
vulnerability_alerts | Предоставляет доступ для получения Dependabot alerts в репозитории. Дополнительные сведения см. на странице Сведения о Dependabot alerts. Это может быть none, read или write. |
watching | Предоставляет доступ к репозиториям списков и изменений, на которые подписан пользователь. Это может быть none, read или write. |
События веб-перехватчика GitHub App
| Имя события веб-перехватчика | Требуемое разрешение | Описание |
|---|---|---|
check_run | checks | Произошло действие выполнения проверок. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API "Выполнения проверок". |
check_suite | checks | Произошло действие набора проверок. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API "Наборы проверок". |
commit_comment | contents | Создается комментарий к фиксации. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API "комментарий к фиксации". |
create | contents | Создается ветвь или тег Git. Дополнительные сведения см. в статье о REST API "База данных Git". |
delete | contents | Удаляется ветвь или тег Git. Дополнительные сведения см. в статье о REST API "База данных Git". |
deployment | deployments | Создается развертывание. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API развертывания. |
deployment_status | deployments | Создается развертывание. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API развертываний. |
fork | contents | Пользователь создает вилку репозитория. Дополнительные сведения см. в разделе Создание вилок REST API. |
gollum | contents | Вики-страница создается или обновляется. Дополнительные сведения см. в статье "Сведения о вики-страницах". |
issues | issues | Действие, связанное с проблемой. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API проблем. |
issue_comment | issues | Действия, связанные комментарием к проблеме или запросу на вытягивание. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе о REST API комментариев к проблемам. |
label | metadata | Действие, связанное с меткой. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API меток. |
member | members | Действия, связанные с участниками совместной работы в репозитории. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API участников совместной работы. |
membership | members | Действие, связанное с членством в команде. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API членов команды. |
milestone | pull_request | Действия, связанные с вехами. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API вех. |
org_block | organization_administration | Действие, связанное с блокировкой людей в организации. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API блокировки пользователей организации. |
organization | members | Действие, связанное с организацией и ее членами. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API организаций. |
page_build | pages | Представляет попытку сборки сайта GitHub Pages, независимо от успешности ее выполнения. Это событие активируется при отправке в ветвь с поддержкой GitHub Pages (gh-pages для страниц проекта, ветвь по умолчанию для страниц пользователей и организаций). |
project | repository_projects или organization_projects | Действие, связанное с классические проекты. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе проекты REST API. |
project_card | repository_projects или organization_projects | Действие, связанное с карточками в классический проект. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API карточек проектов. |
project_column | repository_projects или organization_projects | Действие, связанное со столбцами, которые содержит классический проект. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе столбцы проекта REST API. |
public | metadata | Когда частный репозиторий становится общедоступным. Без сомнения: лучшее событие GitHub. |
pull_request | pull_requests | Действия, связанные с запросами на вытягивание. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе о REST API запросов на вытягивание. |
pull_request_review | pull_request | Действия, связанные с проверками запросов на вытягивание. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе о REST API проверок запросов на вытягивание. |
pull_request_review_comment | pull_request | Действия, связанные с комментариями к проверке запроса на вытягивание в едином различии запроса на вытягивание. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе о REST API комментариев к проверкам запросов на вытягивание. |
pull_request_review_thread | pull_request | Действие, связанное с отметкой ветви обсуждения по запросу на включение внесенных изменений как завершенной или незавершенной. Тип действия указывается в свойстве action объекта полезных данных. |
push | contents | Одна или несколько фиксаций отправляются в ветвь репозитория или тег. |
release | contents | Действие, связанное с выпуском. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API выпуски. |
repository | metadata | Действие, связанное с репозиторием. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе о REST API репозиториев. |
repository_dispatch | contents | Позволяет интеграторам, использующим GitHub Actions, запускать пользовательские события. |
status | statuses | При изменении состояния фиксации в GIT. Дополнительные сведения см. в описании REST API состояний. |
team | members | Действие, связанное с командой организации. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в статье о REST API команд. |
team_add | members | При добавлении репозитория для команды. |
watch | metadata | Когда кто-то запускает репозиторий. Тип действия указывается в свойстве action объекта полезных данных. Дополнительные сведения см. в разделе Пометка звездочкой REST API. |