修改 GitHub 应用注册

注册 GitHub 应用后，您可以对其进行更改。

本文内容

关于 GitHub 应用修改

您可以修改您的 GitHub 应用注册，以更改在最初注册应用时选择的任何设置。有关您在注册 GitHub 应用时可以选择设置的更多信息，请参阅“注册 GitHub 应用”。

例如，您可以更改应用的名称和描述、授予应用的权限、应用订阅的 Webhook 或应用的可见性。

您还可以选择为您的 GitHub 应用测试新的可选功能。有关更多信息，请参阅“为 GitHub 应用激活可选功能”。

要修改 GitHub 应用，首先导航到应用设置页面。

  1. 在 GitHub 上任何页面的右上角，点击您的个人资料照片。
  2. 导航到您的帐户设置。
    • 对于个人帐户拥有的应用，点击 **设置**。
    • 对于组织拥有的应用
      1. 点击 **您的组织**。
      2. 在组织的右侧，点击 **设置**。
  3. 在左侧边栏中，点击 ** 开发者设置**。
  4. 在左侧边栏中，点击 **GitHub 应用**。
  5. 在您要修改的 GitHub 应用的右侧，点击 **编辑**。

更改 GitHub 应用的基本信息

您可以更改 GitHub 应用的基本信息，例如应用名称、应用描述和应用主页 URL。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在“基本信息”下，修改您要更改的 GitHub 应用信息。
  3. 点击 **保存更改**。

在安装期间请求用户授权 (OAuth)

您可以在用户安装应用时提示他们授权您的 GitHub 应用并生成用户访问令牌。当您在安装期间请求用户授权 (OAuth) 时，您还必须提供一个回调 URL，用户在授权安装后将被重定向到该 URL。有关更多信息，请参阅“为 GitHub 应用生成用户访问令牌”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在“识别和授权用户”下，选择或取消选择 **在安装期间请求用户授权 (OAuth)**。
  3. 在“回调 URL”下，输入用户授权安装后重定向到的完整 URL。

启用或禁用设备流

您可以使用设备流为无头应用（如 CLI 工具或 Git 凭据管理器）授权用户。有关使用设备流与 GitHub 应用的更多信息，请参阅“为 GitHub 应用生成用户访问令牌”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在“识别和授权用户”下，选择或取消选择 **启用设备流**。

添加或更新设置 URL

安装应用程序后，您可以将用户重定向到特定 URL。有关更多信息，请参阅“注册 GitHub 应用程序”。

如果您选择“在安装期间请求用户授权（OAuth）”，则无法输入设置 URL。相反，用户将在授权流程中被重定向到回调 URL，您可以在其中描述其他设置。有关更多信息，请参阅“关于用户授权回调 URL”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在“安装后”的“设置 URL”字段中，输入您希望在用户安装应用程序后将用户重定向到的 URL。
  3. 可选地，如果您希望在用户更新安装后将用户重定向到设置 URL，请选择“在更新时重定向”。更新包括为安装添加或删除存储库。如果“设置 URL”为空，则将忽略此选项。

更改 GitHub 应用程序的权限

您可以使用以下步骤更改授予 GitHub 应用程序的访问权限。

当您更改应用程序的“存储库”或“组织”权限时，安装了应用程序的每个帐户都需要批准新的权限。当您更改应用程序的“帐户”权限时，每个授权了应用程序的用户都需要批准权限更改。在这两种情况下，GitHub 都会向每个组织所有者或用户发送电子邮件，通知他们更新应用程序权限的请求。更新后的权限在批准新权限之前不会对安装或用户授权生效。您可以使用 安装 Webhook 了解人们何时接受应用程序的新权限。

更改应用程序的权限也可能会更改应用程序可以订阅的 Webhook 以及应用程序可以使用 API 执行的操作。有关更多信息，请参阅“为 GitHub 应用程序选择权限”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在 GitHub 应用程序设置侧边栏中，单击“权限和事件”。
  3. 在“存储库权限”、“组织权限”和“帐户权限”部分下，修改您要更改的权限。对于每种类型的权限，从下拉菜单中选择“只读”、“读写”或“无访问权限”。有关更多信息，请参阅“为 GitHub 应用程序选择权限”。
  4. 可选地，在“向用户添加说明”下，添加一条说明，告知用户您更改 GitHub 应用请求的权限的原因。
  5. 点击 **保存更改**。

激活或停用 GitHub 应用 Webhook

您可以配置您的 GitHub 应用以接收 GitHub 上特定事件的 Webhook，并自动对其采取行动。有关更多信息，请参阅“使用 GitHub 应用的 Webhook”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在“Webhook”下，要启用或禁用 Webhook，请选择或取消选择 **Active**。
  3. 如果您在上一步中选择了 **Active**，则在“Webhook URL”下，输入 GitHub 应将 Webhook 事件发送到的 URL。
  4. 可选地，如果您在上一步中选择了 **Active**，则在“Webhook 密钥”下，输入一个密钥令牌以保护您的 Webhook。GitHub 强烈建议您设置一个 Webhook 密钥。

更改 GitHub 应用的 Webhook 事件订阅

您可以使用以下步骤更改 GitHub 应用订阅的 Webhook 事件。

您可以为 GitHub 应用注册选择的特定 Webhook 事件取决于您为应用选择的权限类型。您首先需要选择您希望应用拥有的权限，然后您可以将应用订阅与该权限集相关的 Webhook 事件。有关更多信息，请参阅“使用 GitHub 应用的 Webhook”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 激活 GitHub 应用 Webhook。有关更多信息，请参阅本文中的“激活或停用 GitHub 应用 Webhook”。
  3. 在 GitHub 应用程序设置侧边栏中，单击“权限和事件”。
  4. 在“存储库权限”、“组织权限”和“帐户权限”部分下，选择应用将订阅的事件所需的权限。有关更多信息，请参阅“更改 GitHub 应用的权限”。
  5. 在“订阅事件”下，选择您希望 GitHub 应用接收的 Webhook 事件。
  6. 点击 **保存更改**。

更改 GitHub 应用的可见性

您可以更改 GitHub 应用的可见性设置，以控制谁可以安装它。如果公共应用已安装在其他帐户上，则无法将其设为私有。有关更多信息，请参阅“将 GitHub 应用设为公共或私有”。

  1. 导航到您要修改的应用的设置页面。有关更多信息，请参阅本文中的“导航到您的 GitHub 应用设置”。
  2. 在左侧边栏中，单击 **高级**。
  3. 在“危险区域”下，根据 GitHub 应用的当前可见性，单击 **设为公共** 或 **设为私有**。