教程:为 GitHub Enterprise Managed User 配置自动用户预配

本教程介绍了在 GitHub Enterprise Managed User 和 Microsoft Entra ID 中配置自动用户预配所需的步骤。 配置后,Microsoft Entra ID 会使用 Microsoft Entra 预配服务自动将用户和组预配到 GitHub Enterprise Managed User 以及取消预配。 有关此服务的功能、工作原理以及常见问题的重要详细信息,请参阅使用 Microsoft Entra ID 自动将用户预配到 SaaS 应用程序和取消预配

注意

GitHub Enterprise 托管用户 (EMU) 是不同类型的 GitHub Enteprise 帐户。 如果你没有特意请求 EMU 实例,则你拥有的是标准 GitHub Enterprise 账户。 在这种情况下,请参阅文档以在非 EMU 组织中配置用户预配。 标准 GitHub Enterprise 帐户不支持用户预配,但标准 GitHub Enterprise 帐户下的组织支持用户预配。

支持的功能

  • 在 GitHub Enterprise Managed User 中创建用户
  • 当用户不再需要访问权限时将其从 GitHub Enterprise Managed User 中删除
  • 使用户属性在 Microsoft Entra ID 和 GitHub Enterprise Managed User 之间保持同步
  • 在 GitHub Enterprise Managed User 中预配组和组成员身份
  • 单一登录到 GitHub Enterprise Managed User(推荐)

注意

此预配连接器仅对 Enterprise Managed User beta 版参与者启用。

先决条件

本教程中概述的方案假定你已具有以下先决条件:

  • 一个 Microsoft Entra 租户
  • 具有配置预配权限的 Microsoft Entra ID 用户帐户(例如应用程序管理员、云应用程序管理员、应用程序所有者或全局管理员)。
  • 企业托管用户启用了 GitHub Enterprise,并配置为通过 Microsoft Entra 租户以 SAML SSO 登录。

注意

此集成也可以通过 Microsoft Entra 美国政府云环境使用。 你可以在“Microsoft Entra 美国政府云应用程序库”中找到此应用程序,并以公有云相同的方式对其进行配置。

步骤 1:规划预配部署

  1. 了解预配服务的工作原理
  2. 确定谁在预配范围中。
  3. 确定在 Microsoft Entra ID 和 GitHub Enterprise Managed User 之间映射的数据

步骤 2:使用 Microsoft Entra ID 将 GitHub Enterprise Managed User 配置为支持预配

  1. 租户 URL 为 https://api.github.com/scim/v2/enterprises/{enterprise}。 将在 GitHub Enterprise Managed User 应用程序的“预配”选项卡中的“租户 URL”字段中输入此值。

  2. 以 GitHub Enterprise Managed User 管理员身份导航到右上角 -> 然后依次单击个人资料照片 ->“设置”。

  3. 在左侧边栏中,单击“开发人员设置”。

  4. 在左侧边栏中,单击“个人访问令牌”。

  5. 单击“生成新令牌”。

  6. 为此令牌选择 admin:enterprise 范围。

  7. 单击“生成令牌”。

  8. 复制并保存机密令牌。 将在 GitHub Enterprise Managed User 应用程序的“预配”选项卡中的“机密令牌”字段输入此值。

从 Microsoft Entra 应用程序库添加 GitHub Enterprise Managed User,以开始管理对 GitHub Enterprise Managed User 的预配。 如果以前为 GitHub Enterprise Managed User 设置过 SSO,则可以使用同一应用程序。 但建议你在最初测试集成时创建一个单独的应用。 若要详细了解如何从库中添加应用,可以单击此处

步骤 4:定义谁在预配范围中

借助 Microsoft Entra 预配服务,可根据对应用程序的分配和用户/组的属性来限定谁在预配范围内。 如果选择根据分配来限定要将谁预配到应用,可以按照下面的步骤操作,将用户和组分配到应用。 如果选择仅根据用户或组的属性来限定要对谁进行预配,可以使用此处所述的范围筛选器。

  • 先小部分测试。 在向全员推出之前,请先使用少量的用户和组进行测试。 如果预配范围设置为分配的用户和组,则可以先尝试将一两个用户或组分配到应用。 当预配范围设置为所有用户和组时,可以指定基于属性的范围筛选器

  • 如果你需要其他角色,可以更新应用程序清单以添加新角色。

步骤 5:为 GitHub Enterprise Managed User 配置自动用户预配

本部分逐步介绍了如何配置 Microsoft Entra 预配服务,以根据 Microsoft Entra ID 中的用户和/或组分配在 TestApp 中创建、更新和禁用用户和/或组。

在 Microsoft Entra ID 中为 GitHub Enterprise Managed User 配置自动用户预配的方法:

  1. 至少以云应用程序管理员身份登录到 Microsoft Entra 管理中心

  2. 浏览到“标识”>“应用程序”>“企业应用程序”

    Enterprise applications blade

  3. 在“应用程序”列表中,选择“GitHub Enterprise Managed User”。

    The GitHub Enterprise Managed User link in the Applications list

  4. 选择“预配” 选项卡。

    Provisioning tab

  5. 将“预配模式” 设置为“自动” 。

    Provisioning tab automatic

  6. 在“管理员凭据”部分,输入 GitHub Enterprise Managed User 租户 URL 和机密令牌。 单击“测试连接”,确保 Microsoft Entra ID 可连接到 GitHub Enterprise Managed User。 如果连接失败,请确保 GitHub Enterprise Managed User 帐户已将机密令牌创建为企业所有者并重试。

    Token

  7. 在“通知电子邮件”字段中,输入应接收预配错误通知的个人或组的电子邮件地址,并选中“发生故障时发送电子邮件通知”复选框 。

    Notification Email

  8. 选择“保存”。

  9. 在“映射”部分下,选择“将 Microsoft Entra 用户同步到 GitHub Enterprise Managed User”。

  10. 在“属性映射”部分,查看从 Microsoft Entra ID 同步到 GitHub Enterprise Managed User 的用户属性。 选为“匹配”属性的特性用于匹配 GitHub Enterprise Managed User 中的用户帐户以执行更新操作。 如果选择更改匹配目标属性,则需要确保 GitHub Enterprise Managed User API 支持基于该属性筛选用户。 选择“保存”按钮以提交任何更改。

    Attribute 类型 支持筛选
    externalId String
    userName 字符串
    活动 Boolean
    角色 字符串
    displayName 字符串
    name.givenName 字符串
    name.familyName 字符串
    name.formatted 字符串
    emails[type eq "work"].value 字符串
    emails[type eq "home"].value 字符串
    emails[type eq "other"].value 字符串
  11. 在“映射”部分下,选择“将 Microsoft Entra 组同步到 GitHub Enterprise Managed User”。

  12. 在“属性映射”部分,查看从 Microsoft Entra ID 同步到 GitHub Enterprise Managed User 的组属性。 选为“匹配”属性的特性用于匹配 GitHub Enterprise Managed User 中的组以执行更新操作。 选择“保存”按钮以提交任何更改。

    Attribute 类型 支持筛选
    externalId String
    displayName 字符串
    members 参考
  13. 若要配置范围筛选器,请参阅范围筛选器教程中提供的以下说明。

  14. 要为 GitHub Enterprise Managed User 启用 Microsoft Entra 预配服务,请在“设置”部分将“预配状态”更改为“启用”。

    Provisioning Status Toggled On

  15. 通过在“设置”部分的“范围”中选择所需的值,定义要预配到 GitHub Enterprise Managed User 的用户和/或组 。

    Provisioning Scope

  16. 已准备好预配时,单击“保存” 。

    Saving Provisioning Configuration

此操作会对“设置”部分的“范围”中定义的所有用户和组启动初始同步周期 。 初始周期执行的时间比后续周期长,只要 Microsoft Entra 预配服务正在运行,后续周期大约每 40 分钟就会进行一次。

步骤 6:监视部署

配置预配后,请使用以下资源来监视部署:

  1. 通过预配日志来确定哪些用户已预配成功或失败
  2. 检查进度栏来查看预配周期的状态以及完成进度
  3. 如果怀疑预配配置处于非正常状态,则应用程序将进入隔离状态。 可在此处了解有关隔离状态的详细信息。

其他资源

后续步骤