Set up the GitHub service for GitHub Cloud Issues connector ingestion

The GitHub Cloud Issues Microsoft 365 Copilot connector allows your organization to index issues stored in GitHub to make them available in Microsoft 365 Copilot and search experiences. This article provides information about the configuration steps that GitHub admins must complete before your organization deploys the GitHub Cloud Issues connector.

For information about how to deploy the connector, see Deploy the GitHub Issues connector.

Setup checklist

The following checklist lists the steps involved in configuring the environment and setting up the connector prerequisites.

Identify the GitHub organization name

Determine which GitHub organization you want to index when you set up the connector.

Ensure API access to the target GitHub instance

Confirm that your GitHub instance is accessible via API.

Identify Entra ID mapping rules

Define the Entra ID mapping rules. Make sure that users who access the indexed GitHub data have corresponding Entra ID identities to enable accurate permission mapping.

Sign in to the GitHub account

For enterprise-managed users who authenticate through single sign-on (SSO), make sure the account is signed in before you perform any setup actions. Currently, the GitHub authentication flow doesn't support SSO-based sign-in during configuration.

Use a custom GitHub app for authentication (optional)

For the most streamlined setup experience, use the GitHub app managed by Microsoft.

You can also choose to use your own GitHub app for authentication. If you choose this option, follow the steps in the following checklist to complete the setup.

Create and configure the GitHub app

To create a GitHub app for use with the GitHub Cloud Issues connector:

1. In GitHub, select your profile photo on the top right, select Your organizations, and choose the organization the connector should pull data from.

2. On the organization overview page, select Settings.

3. In the left sidebar, scroll down to Developer settings and select GitHub Apps.

4. Select New GitHub App.

5. Configure the app:

   • GitHub app name: Enter the name of your choice.
   • Homepage URL: Copy the URL from your browser's address bar.
   • Callback URL:
     • For Microsoft 365 for enterprise: https://gcs.office.com/v1.0/admin/oauth/callback
     • For Microsoft 365 Government: https://gcsgcc.office.com/v1.0/admin/oauth/callback

   

6. Uncheck the Webhook option.

7. Set the following permissions:

   Repository permissions

   • Administration - Read-only
   • Metadata - Read-only
   • Issues - Read-only
   • Webhooks - Read and Write

   Organization permissions

   • Administration - Read-only
   • Members - Read-only
   • Webhooks - Read and Write

   Account permissions

   • Email addresses - Read-only

8. Under Where can this GitHub App be installed, select Any account, and then select Create GitHub App.

Create credentials for the GitHub App

• On the GitHub app's General page, select Generate a new client secret to generate and copy the client secret.

  

Install the GitHub App

1. On the General page of the GitHub app, select Install App.

   

2. Select the organization where you want to install the app.

   

Configure firewall settings

For added security, you can configure IP firewall rules for your Azure SQL Server or database. For more information, see IP firewall rules.

Add the following client IP ranges in the firewall settings.

IP restrictions can cause the connector to stop working and lead to crawl failures. To resolve this issue, add the connector's IP address to the allowlist.

Next step