> ## Documentation Index
> Fetch the complete documentation index at: https://docs.snapsec.co/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub

> Integrate GitHub with AIM to automatically ingest repository metadata, ownership details, and linked assets.

## Overview

The **GitHub integration for AIM** allows you to automatically pull repository information, metadata, ownership data, and associated assets directly into your Asset Inventory.\
This ensures your development ecosystem remains continuously monitored, up-to-date, and accurately attributed.

![](https://mintlify.s3.us-west-1.amazonaws.com/snapsec-23724fa2/images/aim/integrations/github.png)

GitHub Integration Overview

***

## What This Integration Does

With GitHub connected, AIM can:

* Discover repositories under your organization
* Sync repository metadata such as description, visibility, and activity
* Track associated technologies, owners, and tags
* Enrich AIM’s asset catalog with GitHub-origin assets
* Keep repository inventory updated automatically through adapter syncs

This eliminates manual tracking and ensures developers and security teams have a shared, accurate source of truth.

***

## Prerequisites

Before configuring GitHub, ensure you have:

* A GitHub **organization** or **user account**
* A GitHub **Personal Access Token (PAT)** with the required scopes
* AIM workspace access with integration permissions

### Required GitHub scopes

Your PAT must include:

* `repo` — to read repositories
* `read:org` — to fetch organization membership
* `admin:repo_hook` *(optional)* — if enabling webhook-based syncs

***

## How to Configure GitHub in AIM

**1. Open the GitHub Integration**

Go to **AIM → Integrations** and select the **GitHub** integration tile.

**2. Enter Access Token**

Paste your GitHub Personal Access Token in the required field.

**3. Select Organization**

Choose the GitHub organization or user scope you want AIM to scan.

**4. Click Install**

AIM will verify credentials and begin syncing repositories.

***

## Sync Behavior

After installation:

* AIM pulls repository lists and metadata
* Repository changes are synced periodically via adapters
* Deletions or inactivity are flagged for lifecycle review
* Asset relations for repos (employees, technologies, exposure, etc.) are updated continuously

***

## Troubleshooting

### Invalid token

* Ensure your PAT includes the correct scopes
* Confirm the token has not expired or been revoked

### Organization not visible

* The PAT-linked user must be a member of the organization
* Check GitHub org SSO requirements

### No repositories syncing

* Ensure the selected visibility settings (private/public) match your repos
* Verify the integration run logs under **Adapters → Logs**

***

## Next Steps

> [card] [View Repository Assets](https://docs.snapsec.co/products/aim/repo)
>
> Explore repositories synced from GitHub inside the AIM Repository Catalog.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.