This connector is in beta. Use it if you are a GitHub Enterprise Cloud
customer who can install one GitHub App on the enterprise and on each of its
organizations, and want every organization in the enterprise synced through one
connector. If you need personal access token authentication or capabilities
this connector does not cover (see
What this connector covers), see
Choose a GitHub connector to find the GitHub
connector that offers them.
What this connector covers
Unique to this connector:- One connector for the whole enterprise, instead of one connector per organization.
- Enterprise teams: sync and provisioning.
- Enterprise-level invitations: account provisioning invites users to the enterprise as unaffiliated members.
- Personal access token authentication (GitHub App only)
- Organization roles
- Licenses
- Secrets and non-human identities
- Member last activity
- Enterprise owner provisioning (enterprise owners are synced but cannot be granted or revoked)
- Account deletion
Capabilities
Additional functionality:
The GitHub Enterprise Cloud connector supports account provisioning by inviting
new users directly to the enterprise as unaffiliated members. The connector
returns action required until the user accepts the GitHub invitation.
Account provisioning and Enterprise Managed Users (EMU)
Account provisioning invites users to the enterprise, which is not how Enterprise Managed Users (EMU) accounts are created. According to GitHub’s documentation, EMU accounts are provisioned by your identity provider (IdP) through SCIM rather than invited (Inviting users to join your organization: “Managed user accounts are provisioned using SCIM, not invited.”). If your enterprise uses EMU, create accounts through your identity provider’s GitHub SCIM integration instead of through C1 account provisioning. On an EMU enterprise, the enterprise invitation is expected to fail with an error from GitHub. The connector still syncs existing EMU users and governs their access to organizations, enterprise teams, teams, and repositories. Memberships that are managed by your identity provider may not be modifiable from C1.Gather GitHub Enterprise Cloud credentials
1
Copy the GitHub Enterprise Cloud enterprise slug.
2
Create or select a GitHub App that is installed on the enterprise.
3
Grant the enterprise installation read access for enterprise members and
organizations. If C1 should discover organization installations, also grant
read access for enterprise organization installations. To invite new
members through C1, also grant Enterprise people management write
access on the enterprise installation. Grant enterprise Enterprise
teams read access to sync enterprise teams and member grants, or write
access to manage enterprise team membership.
4
Install the same GitHub App on each organization that C1 should sync. Grant
Members read access for sync, or Members write access if C1 should
invite users or manage organization and team membership. Grant organization
Administration read access so C1 can read each organization’s default
repository permission and model base-permission repository access.
5
Grant repository Metadata read access and Administration read access
for repository access sync. Use Administration write access if C1 should
manage repository collaborators or team repository access.
6
Copy the GitHub App ID.
7
Download the GitHub App private key.
8
Copy the enterprise installation ID for the GitHub App.
Configuration fields
Synced resource types
- Enterprise: the configured enterprise, with member and owner grants.
- Enterprise teams: enterprise teams, with member grants.
- Organizations: organizations in the enterprise, with member and owner grants.
- Users: organization members discovered across synced organizations.
- Organization teams: organization teams, with member and maintainer grants.
- Repositories: organization repositories, with pull, triage, push, maintain, and admin grants for users, organization teams, and enterprise teams. Organization-wide access is expanded from the organization: the default repository permission reaches every member, owners included, and owners additionally receive the roles above it (every role when the default permission is none).
Special notes
- Team maintainers are also emitted as team members.
- Repository team grants are expandable through the corresponding team member, team maintainer, and enterprise team member entitlements.
- Organization provisioning currently supports revocation. Revoking an organization member removes that user from the organization; revoking an organization owner demotes the user to member.
- Account provisioning sends or reuses a pending unaffiliated enterprise-member
invitation via the
inviteEnterpriseMemberGraphQL mutation; no org is required. The account profile must include an email or a GitHub login, and the result remains action required until the user accepts the invitation.
Configure the GitHub Enterprise Cloud connector
- Cloud-hosted
- Self-hosted
Follow these instructions to use a built-in, no-code connector hosted by C1.Done. Your GitHub Enterprise Cloud connector is now pulling access data into C1.
1
In C1, navigate to Apps > Connectors and click Add connector.
2
Search for GitHub Enterprise Cloud and click Add.
3
Choose where to add the connector: Create a new app, or Add to an existing app (then select the app).If you’re creating a new app, choose whether to link it to an application discovered from your identity provider: select Yes and pick the IdP application, or No to continue with just the connector.
4
Set the connector’s Name and, optionally, a Description.
5
Click the pencil icon next to Owners to choose who can configure and manage this connector.
6
Click Add. The connector is created and its configuration page opens.
7
Find the Settings area of the page and click Edit.
8
Paste the GitHub Enterprise Cloud credentials into the relevant fields:
- Enterprise slug: The GitHub enterprise slug.
- GitHub App ID: The GitHub App ID.
- GitHub App private key: The private key file for the GitHub App.
- GitHub App installation ID: The enterprise installation ID.
- Skip organizations without the GitHub App (optional): Turn this on to skip organizations where the GitHub App is not installed or its installation is suspended, instead of failing the sync. See the warning in Gather GitHub Enterprise Cloud credentials.
9
Click Save.
10
The connector’s label changes to Syncing, followed by
Connected. You can view the logs to ensure that information is
syncing.