Apidog supports connecting to GitHub Enterprise Cloud data residency environments that use a dedicated ghe.com tenant domain, such as:With this integration, your organization can connect Apidog to repositories hosted on GitHub Enterprise Cloud data residency, then import OpenAPI files, create Git connections, and back up API specifications to your enterprise GitHub repositories.GitHub Enterprise Cloud data residency is available on the Enterprise plan. What is supported#
This integration supports GitHub Enterprise Cloud data residency SaaS tenants using a *.ghe.com domain.Supported examples#
https://company.ghe.com
https://team-73.ghe.com
Not supported#
http://company.ghe.com
https://github.company.com
https://sub.company.ghe.com
https://company.ghe.com/custom-path
This feature is designed for GitHub Enterprise Cloud data residency. It does not support self-hosted GitHub Enterprise Server or arbitrary custom GitHub domains.
Prerequisites#
Before connecting Apidog to GitHub Enterprise Cloud data residency, make sure you have:1.
An Apidog organization with access to this feature.
2.
Organization administrator permission in Apidog.
3.
A GitHub Enterprise Cloud data residency tenant, for example: 4.
Permission to create an OAuth App on your GitHub Enterprise Cloud tenant.
5.
Access to the GitHub organizations, repositories, and branches you want to connect.
Create an OAuth App in GitHub Enterprise Cloud#
First, create an OAuth App on your GitHub Enterprise Cloud tenant.1.
Sign in to your GitHub Enterprise Cloud data residency site, for example: 2.
Go to the OAuth Apps settings page.
4.
Enter the application name.
5.
Enter the homepage URL: https://apidog.com.
6.
Enter the authorization callback URL:
https://api.apidog.com/passport/github/callback
9.
Generate and copy the Client Secret.
1.
Open your Apidog organization.
2.
Go to Organization Settings.
4.
Find GitHub Enterprise Cloud Data Residency.
6.
Enter the GitHub Enterprise Cloud host URL, for example: 7.
Select OAuth App as the authentication method.
8.
Enter the OAuth App Client ID.
9.
Enter the OAuth App Client Secret.
Connect to a GitHub Enterprise Cloud repository#
After your organization administrator has configured GitHub Enterprise Cloud data residency, users with Git connection permission can connect repositories.1.
Open a project in Apidog.
2.
Go to the Git connection or Git import workflow.
3.
Select GitHub Enterprise Cloud.
4.
Apidog opens the authorization page on your configured ghe.com tenant.
5.
Sign in and authorize Apidog.
6.
Select the GitHub organization.
8.
Select the branch if required.
Import OpenAPI from GitHub Enterprise Cloud#
You can import OpenAPI files from a connected GitHub Enterprise Cloud repository.1.
Start an import workflow in the connected Apidog project.
4.
Select the organization, repository, branch, and file.
6.
Select the target Module to import into or create a new one.
Back up OpenAPI to GitHub Enterprise Cloud#
You can also back up or synchronize OpenAPI content from Apidog to a GitHub Enterprise Cloud repository.1.
Open the relevant project or API specification.
2.
Go to the Git backup or synchronization settings.
3.
Select GitHub Enterprise Cloud.
4.
Choose the connected organization, repository, and branch.
5.
Configure the target file path if required.
6.
Save or start the backup.
Update the GitHub Enterprise Cloud settings#
Organization administrators can update the configured host, Client ID, or Client Secret.1.
Go to Organization Settings.
3.
Find the GitHub Enterprise Cloud data residency settings.
5.
Update the host URL or Client ID if needed.
6.
To rotate the Client Secret, enter a new Client Secret.
If you leave the Client Secret field empty while editing, Apidog keeps the existing Client Secret.
Clear the settings#
Organization administrators can clear the GitHub Enterprise Cloud data residency settings.1.
Go to Organization Settings.
3.
Find the GitHub Enterprise Cloud data residency settings.
Existing connections may require reconfiguration or reauthorization depending on their token status and your organization settings.
OAuth scopes#
When authorizing Apidog, GitHub Enterprise Cloud may show the permissions requested by the OAuth App.Apidog uses these permissions to:Read the organizations available to the authorized user.
Read repositories and branches.
Import OpenAPI files from repositories.
Back up or synchronize OpenAPI content to repositories.
Manage repository hooks when required by Git synchronization workflows.
github.com.Security notes#
Apidog handles GitHub Enterprise Cloud credentials and tokens securely.The Client Secret is not displayed after configuration.
The Client Secret is not prefilled when editing settings.
Users cannot view the Client Secret from the organization settings page.
Only organization administrators can configure or clear the integration.
Project-level Git connection permissions are still required to create or update Git connections.
GitHub Enterprise Cloud authorization is performed through your configured ghe.com tenant.
Troubleshooting#
Possible causes:
Your organization does not have access to this feature.
GitHub Enterprise Cloud data residency has not been configured by an organization administrator.
You are not in the organization where the integration was configured.
