1
0
mirror of synced 2026-01-11 03:01:04 -05:00
Files
docs/translations/ru-RU/content/developers/apps/building-github-apps/creating-a-github-app-using-url-parameters.md
2022-12-12 17:21:29 +00:00

26 KiB
Raw Blame History

title, intro, redirect_from, versions, topics, shortTitle, ms.openlocfilehash, ms.sourcegitcommit, ms.translationtype, ms.contentlocale, ms.lasthandoff, ms.locfileid
title intro redirect_from versions topics shortTitle ms.openlocfilehash ms.sourcegitcommit ms.translationtype ms.contentlocale ms.lasthandoff ms.locfileid
Создание GitHub App с использованием параметров URL-адреса Вы можете предварительно выбрать параметры нового {% data variables.product.prodname_github_app %} с помощью [параметров запроса](https://en.wikipedia.org/wiki/Query_string) URL-адреса, чтобы быстро настроить новую конфигурацию {% data variables.product.prodname_github_app %}.
/apps/building-github-apps/creating-github-apps-using-url-parameters
/developers/apps/creating-a-github-app-using-url-parameters
fpt ghes ghae ghec
* * * *
GitHub Apps
App creation query parameters aa54eb3dcd66e86c04a1e95e4da2d45d7858a996 a3e975955a MT ru-RU 10/05/2022 148009944

Сведения параметрах URL-адреса {% data variables.product.prodname_github_app %}

Вы можете добавить параметры запроса к этим URL-адресам, чтобы предварительно выбрать конфигурацию {% data variables.product.prodname_github_app %} в личной учетной записи или учетной записи организации:

  • Личная учетная запись: {% data variables.product.oauth_host_code %}/settings/apps/new
  • Учетная запись организации: {% data variables.product.oauth_host_code %}/organizations/:org/settings/apps/new

Пользователь, создающий приложение, может изменить предварительно выбранные значения на странице регистрации {% data variables.product.prodname_github_app %} перед отправкой приложения. Если вы не включите обязательные параметры в строку запроса URL-адреса, например name, пользователь, создающий приложение, должен будет ввести значение перед отправкой приложения.

Для приложений, которым требуется секрет для защиты веб-перехватчика, значение секрета должно быть установлено в форме пользователем, создающим приложение, а не с помощью параметров запроса. Дополнительные сведения см. в разделе Обеспечение безопасности веб-перехватчиков.

Следующий URL-адрес создает новое общедоступное приложение с именем octocat-github-app с предварительно настроенным описанием и URL-адресом обратного вызова. Этот URL-адрес также выбирает разрешения на чтение и запись для checks, подписывается на события веб-перехватчика check_run и check_suite, а также выбирает вариант запроса авторизации пользователя (OAuth) во время установки:

{% data variables.product.oauth_host_code %}/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

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

Параметры конфигурации {% data variables.product.prodname_github_app %}

Имя Тип Описание
name string Имя {% data variables.product.prodname_github_app %}. Присвойте своему приложению краткое и понятное имя. Это имя должно отличаться от имени существующего пользователя GitHub, если только это не ваше собственное имя пользователя или организации. Краткая версия имени вашего приложения будет отображаться в пользовательском интерфейсе, когда ваша интеграция выполнит действие.
description string Описание {% data variables.product.prodname_github_app %}.
url string Полный URL-адрес домашней страницы сайта {% data variables.product.prodname_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-адрес для перенаправления после установки {% data variables.product.prodname_github_app %}, если для приложения требуется дополнительная настройка после установки.
setup_on_update boolean Задайте значение true, чтобы перенаправлять людей на URL-адрес настройки при обновлении установок, например после добавления или удаления репозиториев.
public boolean Задайте значение true, если приложение {% data variables.product.prodname_github_app %} доступно для всех пользователей, или false — если оно доступно только владельцу.
webhook_active boolean Задайте значение false, чтобы отключить веб-перехватчик. Веб-перехватчик включен по умолчанию.
webhook_url string Полный URL-адрес, на который вы хотите отправлять полезные данные события веб-перехватчика.
{% ifversion ghae %}webhook_secret string Вы можете указать секрет для защиты ваших веб-перехватчиков. Дополнительные сведения см. на странице Защита веб-перехватчиков.
{% endif %}events array of strings События веб-перехватчика. Для некоторых событий веб-перехватчика необходимо получить разрешения read или write для ресурса, прежде чем выбрать событие при регистрации нового {% data variables.product.prodname_github_app %}. Сведения о доступных событиях и необходимых для них разрешениях см. в разделе События веб-перехватчика {% data variables.product.prodname_github_app %}. Вы можете выбрать несколько событий в строке запроса. Например, events[]=public&events[]=label.{% ifversion ghes < 3.4 %}
domain string URL-адрес ссылки на содержимое.{% endif %}
single_file_name string Это узкоспециализированное разрешение, позволяющее приложению получать доступ к одному файлу в любом репозитории. При задании разрешения read или write для single_file в этом поле указывается путь к одному файлу, которым будет управлять {% data variables.product.prodname_github_app %}. {% ifversion fpt or ghes or ghec %} Если вам нужно управлять несколькими файлами, см. single_file_paths ниже. {% endif %}{% ifversion fpt or ghes or ghec %}
single_file_paths array of strings Этот параметр позволяет приложению получить доступ к десяти указанным файлам в репозитории. При задании разрешения read или write для single_file этот массив может хранить пути до десяти файлов, которыми будет управлять {% data variables.product.prodname_github_app %}. Все эти файлы получают одно и то же разрешение, заданное single_file, и не имеют отдельных индивидуальных разрешений. При настройке двух или более файлов API возвращает multiple_single_files=true, в противном случае возвращается multiple_single_files=false.{% endif %}

Разрешения {% data variables.product.prodname_github_app %}

Вы можете выбрать разрешения в строке запроса, используя имя разрешения из приведенной ниже таблицы в качестве имени параметра запроса и тип разрешения в качестве значения запроса. Например, чтобы выбрать разрешения Read & write в пользовательском интерфейсе для contents, в строке запроса нужно указать &contents=write. Чтобы выбрать разрешения Read-only в пользовательском интерфейсе для &blocking=read, в строке запроса нужно указать blocking. Чтобы выбрать no-access в пользовательском интерфейсе для checks, ваша строка запроса не должна содержать разрешение checks.

Разрешение Описание
administration Предоставляет доступ к различным конечным точкам для администрирования организации и репозитория. Это может быть none, read или write.{% ifversion fpt or ghec %}
blocking Предоставляет доступ к API блокирования пользователей. Это может быть none, read или write.{% endif %}
checks Предоставляет доступ к API проверок. Это может быть none, read или write.{% ifversion ghes < 3.4 %}
content_references Предоставляет доступ к конечной точке Создание вложения с содержимым. Это может быть none, read или write.{% endif %}
contents Предоставляет доступ к различным конечным точкам, которые позволяют изменять содержимое репозитория. Это может быть none, read или write.
deployments Предоставляет доступ к API развертываний. Это может быть none, read или write.{% ifversion fpt or ghes or ghec %}
emails Предоставляет доступ к API сообщений электронной почты. Это может быть none, read или write.{% endif %}
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.{% ifversion fpt or ghec %}
metadata Предоставляет доступ к конечным точкам только для чтения, которые не допускают утечки конфиденциальных данных. Может иметь значение read или none. Если вы устанавливаете для {% data variables.product.prodname_github_app %} какое-либо разрешение, по умолчанию задается значение read. Если же вы не указываете никаких разрешений, по умолчанию задается значение none.
organization_administration Предоставляет доступ к конечной точке Обновление организации и API ограничений взаимодействия с организацией. Это может быть none, read или write.{% endif %}
organization_hooks Предоставляет доступ к API веб-перехватчиков организации. Это может быть none, read или write.
organization_plan Предоставляет доступ для получения сведений о плане организации с помощью конечной точки Получение организации. Это может быть none или read.
organization_projects Предоставляет доступ к API проектов. Это может быть none, read, write или admin.{% ifversion fpt or ghec %}
organization_user_blocking Предоставляет доступ к API блокирования пользователей организации. Это может быть none, read или write.{% endif %}
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.{% ifversion ghes or ghec %}
secret_scanning_alerts Предоставляет доступ к API сканирования секретов. Это может быть none, read или write.{% endif %}{% ifversion fpt or ghes or ghec %}
security_events Предоставляет доступ к API сканирования кода. Это может быть none, read или write.{% endif %}
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 Предоставляет доступ для получения {% data variables.product.prodname_dependabot_alerts %} в репозитории. Дополнительные сведения см. на странице Сведения о {% data variables.product.prodname_dependabot_alerts %}. Это может быть none, read или write.
watching Предоставляет доступ к репозиториям списков и изменений, на которые подписан пользователь. Это может быть none, read или write.

События веб-перехватчика {% data variables.product.prodname_github_app %}

Имя события веб-перехватчика Требуемое разрешение Описание
check_run checks {% data reusables.webhooks.check_run_short_desc %}
check_suite checks {% data reusables.webhooks.check_suite_short_desc %}
commit_comment contents {% data reusables.webhooks.commit_comment_short_desc %}{% ifversion ghes < 3.4 %}
content_reference content_references {% data reusables.webhooks.content_reference_short_desc %}{% endif %}
create contents {% data reusables.webhooks.create_short_desc %}
delete contents {% data reusables.webhooks.delete_short_desc %}
deployment deployments {% data reusables.webhooks.deployment_short_desc %}
deployment_status deployments {% data reusables.webhooks.deployment_status_short_desc %}
fork contents {% data reusables.webhooks.fork_short_desc %}
gollum contents {% data reusables.webhooks.gollum_short_desc %}
issues issues {% data reusables.webhooks.issues_short_desc %}
issue_comment issues {% data reusables.webhooks.issue_comment_short_desc %}
label metadata {% data reusables.webhooks.label_short_desc %}
member members {% data reusables.webhooks.member_short_desc %}
membership members {% data reusables.webhooks.membership_short_desc %}
milestone pull_request {% data reusables.webhooks.milestone_short_desc %}{% ifversion fpt or ghec %}
org_block organization_administration {% data reusables.webhooks.org_block_short_desc %}{% endif %}
organization members {% data reusables.webhooks.organization_short_desc %}
page_build pages {% data reusables.webhooks.page_build_short_desc %}
project repository_projects или organization_projects {% data reusables.webhooks.project_short_desc %}
project_card repository_projects или organization_projects {% data reusables.webhooks.project_card_short_desc %}
project_column repository_projects или organization_projects {% data reusables.webhooks.project_column_short_desc %}
public metadata {% data reusables.webhooks.public_short_desc %}
pull_request pull_requests {% data reusables.webhooks.pull_request_short_desc %}
pull_request_review pull_request {% data reusables.webhooks.pull_request_review_short_desc %}
pull_request_review_comment pull_request {% data reusables.webhooks.pull_request_review_comment_short_desc %}
pull_request_review_thread pull_request {% data reusables.webhooks.pull_request_review_thread_short_desc %}
push contents {% data reusables.webhooks.push_short_desc %}
release contents {% data reusables.webhooks.release_short_desc %}
repository metadata {% data reusables.webhooks.repository_short_desc %}{% ifversion fpt or ghec %}
repository_dispatch contents Позволяет интеграторам, использующим GitHub Actions, запускать пользовательские события.{% endif %}
status statuses {% data reusables.webhooks.status_short_desc %}
team members {% data reusables.webhooks.team_short_desc %}
team_add members {% data reusables.webhooks.team_add_short_desc %}
watch metadata {% data reusables.webhooks.watch_short_desc %}