Note!
If you do not intend to use a self-hosted Axiom Runner for your GitHub integration, we recommend that you use the OAuth based integration method, which is much simpler.
Overview
In order to start managing access to GitHub using Axiom, you first need to integrate your GitHub organization to Axiom. Learn more about integrations
Integration summary:
Create a GitHub app in the GitHub console.
Configure the integration in the Axiom console.
Wait for the initial Scan to complete.
Detailed guide
GitHub
Go to the GitHub dashboard, and select your organization
Go to https://github.com/settings/apps/new
(or go to Settings -> Developer Settings -> New GitHub App)Name the app (for example “Axiom Integration), give it a description, and enter https://app.axiom.security/ in the “Homepage URL” field
Scroll down, and uncheck the “Active” checkbox under Webhook
Scroll down to the Permissions section
Under “Repository permissions”
For “Administration”, select “Read and write”
For “Metadata”, select “Read-only"
Under “Organization permissions”
For “Administration”, select “Read-only”
For “Members”, select “Read and write”
Under “Account Permissions"
For “Email addresses”, select “Read-only”
For “Profile”, select “Read and write”
Scroll down, to “Where can this GitHub App be installed?”
Ensure that “Only on this account” is selected.
Press the “Create GitHub App” button
In the app’s “About” page (this is where you get to after pressing Create)
Generate a new client secret
Scroll down to the “Private keys” section, and press the “Generate a private key” button
This will download a pem file to your computer.
Now scroll back to the top of the “About” page, copy the “App ID”, and choose “Install App” from the left side menu
Press “Install”
Press “Install” again
Grab the Application installation ID from the URL of the page on which you landed
How to find your Application installation ID later
Go to https://github.com/settings/apps, and press Edit next to the application name
Press "Install App"
Press the cogwheel button
Axiom
Enter the information:
Name: The name you want to give this integration (will appear in Axiom).
Organization name: the GitHub organization name, as it appears in the GitHub console.
Application ID: The App ID you copied in step 11 above.
App installation ID: the ID you copied from the URL in step 14 above.
Select the pem file you downloaded in step 10b above, and press the Integrate button
Congratulations!
Your GitHub integration will now appear under the GitHub card in the Axiom console’s Integrations page
Before you can start managing access to GitHub you need to wait for the initial scan to complete.
Scan is the Axiom process of traversing all resources in an integration and creating a map (graph) of these resources, and their relationships. For GitHub we traverse your organization and repos, groups, users, and roles. The initial Scan can several minutes, or longer, depending on how many repos and users you have.