Configure Connection
GitHub guide
Authorize NIM to collect GitHub organization, repository, and release data for review.
Before you startDirect link to Before you start
NIM requires Client ID, Client Secret, and Organization. The Redirect URI is provided on the NIM system's Connection screen; use that value when registering the OAuth app.
Review GitHub's OAuth app registration instructions and your organization's OAuth app access restrictions. The account used to authorize NIM must be able to read the repositories you intend to collect.
Start the connection in NIMDirect link to Start the connection in NIM
- In NIM Studio, open Systems > Overview and add a GitHub system, or select the existing system.
- Open its Connection screen.
- Copy the displayed Redirect URI. Keep this screen available while registering the app in GitHub.
Register the GitHub OAuth appDirect link to Register the GitHub OAuth app
- In GitHub, open Settings > Developer settings > OAuth apps and register an application for NIM.
- Supply the application name and homepage URL. Set Authorization callback URL to the Redirect URI copied from NIM.
- Register the app, obtain its Client ID, and generate a Client Secret.
- Return to NIM and enter these settings:
| NIM setting | Value |
|---|---|
| Client ID | The identifier of the registered GitHub OAuth app. |
| Client Secret | The secret generated for that app. |
| Organization | The GitHub organization login, such as example-org, rather than its full URL. |
- Save the settings and complete the OAuth authorization flow from the NIM Connection screen. Sign in with the intended GitHub account.
- If the organization restricts OAuth app access, have an organization owner approve the app for that organization.
Review the organization's token policyDirect link to Review the organization's token policy
GitHub's personal access token policy guide explains restrictions, lifetimes, and approvals for personal access tokens. Organization owners manage these under Organization Settings > Personal access tokens. Review the policy if your organization also uses those tokens.
This NIM connection uses OAuth app credentials. Personal access token policy is separate from OAuth app approval; a personal access token is not the Client Secret.
Test access and collect dataDirect link to Test access and collect data
- Select Test Connection. NIM calls
GET /organizationsto request organization information. - Confirm the test succeeds, then collect the system.
- Check that the configured organization's expected repositories and releases are present in NIM. Include a private repository in this check if your process needs private data.
- If data is missing, verify the Organization value, the authorizing account's access, and the organization's OAuth app approval.
GitHub documents /organizations as its list organizations endpoint, which can return public data without authentication. A successful test alone does not establish access to your organization's private repositories. Confirm the required data through collection before using it in filters or audit reports.