Skip to content

[CXH-3499] - Docs: baton-github-enterprise — say it covers GHES and GHEC, highlight unique capabilities, fix auth-option inconsistency #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sergiocorral-conductorone merged 3 commits into from
Nov 5, 2026
Merged

[CXH-3499] - Docs: baton-github-enterprise — say it covers GHES and GHEC, highlight unique capabilities, fix auth-option inconsistency #33

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6e9563e
[CXH-3499] docs: cover GHES and GHEC, unique capabilities, auth consi…
sergiocorral-conductorone Oct 27, 2026
b2aff76
[CXH-3499] docs: state instance URL guidance covers github.com, ghe.c…
sergiocorral-conductorone Oct 29, 2026
36ccabd
docs: link the Choose a GitHub connector guide, simplify Instance URL…
luisina-santos Nov 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 20 additions & 11 deletions docs/connector.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,16 @@ sidebarTitle: "GitHub Enterprise"
---

<Tip>
**GitHub versus GitHub Enterprise: which integration should I use?** Follow the instructions on this page if your organization accesses GitHub at a custom domain.
**Which GitHub connector 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 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. To compare the GitHub connectors and pick the right one, see [Choose a GitHub connector](/baton/choose-github-connector).
</Tip>

## Capabilities
Expand All @@ -20,23 +27,25 @@ If you access GitHub at `github.com`, go to the [GitHub](/baton/github) integrat
| Repositories | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Teams | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Orgs\* | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Org roles\*\* | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Enterprise roles\*\*\*\* | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Org roles | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Enterprise roles\*\* | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | <Icon icon="square-check" iconType="solid" color="#c937ae"/> |
| Licenses | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | |
| Secrets - API keys | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | |
| GitHub App | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | |
| GitHub Activity\*\*\* | <Icon icon="square-check" iconType="solid" color="#c937ae"/> | |

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**.

<Note>
**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.
</Note>

\* 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.

<Warning>
Expand All @@ -57,7 +66,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)

Expand Down Expand Up @@ -253,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.
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.

Expand All @@ -272,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.
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.

Expand Down
Loading