From 6e9563e332975d1983febc8cac51371db7fe7e63 Mon Sep 17 00:00:00 2001 From: "sergio.corral" Date: Tue, 27 Oct 2026 12:03:41 -0300 Subject: [PATCH 1/3] [CXH-3499] docs: cover GHES and GHEC, unique capabilities, auth consistency and EMU --- docs/connector.mdx | 23 +++++++++++++++++------ 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/docs/connector.mdx b/docs/connector.mdx index cc8947d..5e09ab1 100644 --- a/docs/connector.mdx +++ b/docs/connector.mdx @@ -7,9 +7,16 @@ sidebarTitle: "GitHub Enterprise" --- -**GitHub versus GitHub Enterprise: which integration should I use?** Follow the instructions on this page if your organization accesses GitHub at a custom domain. +**GitHub versus GitHub Enterprise: which integration should I use?** The GitHub Enterprise connector works with both GitHub Enterprise Server (GHES) and GitHub Enterprise Cloud (GHEC). -If you access GitHub at `github.com`, go to the [GitHub](/baton/github) integration. +This connector offers capabilities that the [GitHub](/baton/github) connector does not: + +- Support for GitHub Enterprise Server +- Enterprise roles, including provisioning of the built-in Enterprise Owner role +- Licenses +- Member last activity + +Choose this connector if you need any of these features, if you authenticate with a personal access token (classic), or if you authenticate with a GitHub App installed on a single organization. ## Capabilities @@ -27,7 +34,11 @@ If you access GitHub at `github.com`, go to the [GitHub](/baton/github) integrat | GitHub App | | | | GitHub Activity\*\*\* | | | -The GitHub Enterprise connector supports [automatic account provisioning and deprovisioning](/product/admin/account-provisioning). New accounts will send an invitation to the account owner; if an invitation is pending, the account status will be shown as **Pending**. +The GitHub Enterprise connector supports [automatic account provisioning and deprovisioning](/product/admin/account-provisioning). New accounts will send an invitation to the account owner; if an invitation is pending, the account status will be shown as **Pending**. + + +**Enterprise Managed Users (EMU):** C1 cannot create accounts in an organization that uses Enterprise Managed Users, because accounts in those organizations are provisioned by your identity provider. The invitation fails with an error stating that accounts are provisioned by the IdP. To create accounts for EMU users, use your identity provider's GitHub SCIM integration. The connector still syncs existing EMU users and governs their access, such as repositories, teams, and roles. + \* Due to limitations on the GitHub API, syncing multiple orgs requires a personal access token (PAT). A separate connector and GitHub app is required when using the GitHub App integration. @@ -57,7 +68,7 @@ Enterprise roles are a GitHub Enterprise Cloud feature. Setting **Enterprises** ## Gather GitHub Enterprise credentials -Configuring the connector requires you to pass in credentials generated in GitHub Enterprise. Gather these credentials before you move on. To set up the GitHub Enterprise connector, you can choose to create either a personal access token (classic) or a fine-grained access token. +Configuring the connector requires you to pass in credentials generated in GitHub Enterprise. Gather these credentials before you move on. To set up the GitHub Enterprise connector, you can choose to create either a personal access token (classic) or a GitHub App. ### Option 1: Use a personal access token (classic) @@ -253,7 +264,7 @@ If you're using a personal access token to set up the connector: 1. Click **Personal access token**. - 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. + 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). This field is required. 1. Paste the token you generated into the **Personal access token** field. @@ -272,7 +283,7 @@ If you're using a GitHub app to set up the connector: 1. Click **GitHub app**. - 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. + 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). This field is required. 1. Enter your app ID into the **GitHub app ID** field. From b2aff761182a0d9aaec5371c896d51487ba94324 Mon Sep 17 00:00:00 2001 From: "sergio.corral" Date: Thu, 29 Oct 2026 20:03:33 -0300 Subject: [PATCH 2/3] [CXH-3499] docs: state instance URL guidance covers github.com, ghe.com untested --- docs/connector.mdx | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/connector.mdx b/docs/connector.mdx index 5e09ab1..fa628a9 100644 --- a/docs/connector.mdx +++ b/docs/connector.mdx @@ -264,7 +264,7 @@ If you're using a personal access token to set up the connector: 1. Click **Personal access token**. - 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). This field is required. + 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). These instructions cover GitHub Enterprise Cloud on `github.com`. GitHub Enterprise Cloud with data residency (`*.ghe.com`) has not been tested with this connector, so this page does not state whether it is supported. This field is required. 1. Paste the token you generated into the **Personal access token** field. @@ -283,7 +283,7 @@ If you're using a GitHub app to set up the connector: 1. Click **GitHub app**. - 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). This field is required. + 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). These instructions cover GitHub Enterprise Cloud on `github.com`. GitHub Enterprise Cloud with data residency (`*.ghe.com`) has not been tested with this connector, so this page does not state whether it is supported. This field is required. 1. Enter your app ID into the **GitHub app ID** field. From 36ccabd38b40336ed9f61f27eb6dff32742c7bcb Mon Sep 17 00:00:00 2001 From: Luisina Santos Date: Wed, 4 Nov 2026 11:18:28 -0300 Subject: [PATCH 3/3] docs: link the Choose a GitHub connector guide, simplify Instance URL and footnotes Keep only real differentiators in the top note, state the Instance URL value for GitHub Enterprise Cloud without the testing caveat, and drop the footnote that called organization roles enterprise licenses. Co-Authored-By: Claude Opus 5.5 --- docs/connector.mdx | 18 ++++++++---------- 1 file changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/connector.mdx b/docs/connector.mdx index fa628a9..80dfe1c 100644 --- a/docs/connector.mdx +++ b/docs/connector.mdx @@ -7,16 +7,16 @@ sidebarTitle: "GitHub Enterprise" --- -**GitHub versus GitHub Enterprise: which integration should I use?** The GitHub Enterprise connector works with both GitHub Enterprise Server (GHES) and GitHub Enterprise Cloud (GHEC). +**Which GitHub connector should I use?** The GitHub Enterprise connector works with both GitHub Enterprise Server (GHES) and GitHub Enterprise Cloud (GHEC). -This connector offers capabilities that the [GitHub](/baton/github) connector does not: +This connector offers capabilities that the other GitHub connectors do not: - Support for GitHub Enterprise Server - Enterprise roles, including provisioning of the built-in Enterprise Owner role - Licenses - Member last activity -Choose this connector if you need any of these features, if you authenticate with a personal access token (classic), or if you authenticate with a GitHub App installed on a single organization. +Choose this connector if you need any of these features. To compare the GitHub connectors and pick the right one, see [Choose a GitHub connector](/baton/choose-github-connector). ## Capabilities @@ -27,8 +27,8 @@ Choose this connector if you need any of these features, if you authenticate wit | Repositories | | | | Teams | | | | Orgs\* | | | -| Org roles\*\* | | | -| Enterprise roles\*\*\*\* | | | +| Org roles | | | +| Enterprise roles\*\* | | | | Licenses | | | | Secrets - API keys | | | | GitHub App | | | @@ -42,12 +42,10 @@ The GitHub Enterprise connector supports [automatic account provisioning and dep \* Due to limitations on the GitHub API, syncing multiple orgs requires a personal access token (PAT). A separate connector and GitHub app is required when using the GitHub App integration. -\*\* Organization roles are also referred to as "enterprise licenses" in GitHub's documentation. +\*\* Only synced when **Enterprises** is set. Only the built-in **Enterprise Owner** role can be provisioned, and only with GitHub App authentication. See [Enterprise Owner provisioning](#enterprise-owner-provisioning) below. \*\*\* Only synced when **Sync user last activity** is enabled. See [Sync member last activity](#sync-member-last-activity) below. -\*\*\*\* Only synced when **Enterprises** is set. Only the built-in **Enterprise Owner** role can be provisioned, and only with GitHub App authentication. See [Enterprise Owner provisioning](#enterprise-owner-provisioning) below. - [This connector can sync secrets](/product/admin/inventory) and display them on the **Inventory** page. @@ -264,7 +262,7 @@ If you're using a personal access token to set up the connector: 1. Click **Personal access token**. - 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). These instructions cover GitHub Enterprise Cloud on `github.com`. GitHub Enterprise Cloud with data residency (`*.ghe.com`) has not been tested with this connector, so this page does not state whether it is supported. This field is required. + 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud on `github.com`, enter `https://github.com` (the default). This field is required. 1. Paste the token you generated into the **Personal access token** field. @@ -283,7 +281,7 @@ If you're using a GitHub app to set up the connector: 1. Click **GitHub app**. - 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud at `github.com`, enter `https://github.com` (the default). These instructions cover GitHub Enterprise Cloud on `github.com`. GitHub Enterprise Cloud with data residency (`*.ghe.com`) has not been tested with this connector, so this page does not state whether it is supported. This field is required. + 1. In the **Instance URL** field, enter the URL of your GitHub Enterprise instance. For GitHub Enterprise Cloud on `github.com`, enter `https://github.com` (the default). This field is required. 1. Enter your app ID into the **GitHub app ID** field.