This feature is only available with an active Enterprise license. Please add your license key to activate it.
This is an experimental feature. Certain functionality may be incomplete and breaking changes may ship in non-major releases. Have feedback? Submit a issue on GitHub.
Overview
Permission syncing allows you to sync Access Permission Lists (ACLs) from a code host to Sourcebot. When configured, users signed into Sourcebot will only be able to access repositories that they have access to on the code host. Practically, this means:- Code Search results will only include repositories that the user has access to.
- Code navigation results will only include repositories that the user has access to.
- MCP results will only include results from repositories the user has access to.
- Ask Sourcebot (and the underlying LLM) will only have access to repositories that the user has access to.
- File browsing is scoped to the repositories that the user has access to.
EXPERIMENT_EE_PERMISSION_SYNC_ENABLED environment variable to true.
Platform support
We are actively working on supporting more code hosts. If you’d like to see a specific code host supported, please reach out.| Platform | Permission syncing |
|---|---|
| GitHub (GHEC & GHEC Server) | ✅ |
| GitLab (Self-managed & Cloud) | ✅ |
| Bitbucket Cloud | 🛑 |
| Bitbucket Data Center | 🛑 |
| Gitea | 🛑 |
| Gerrit | 🛑 |
| Generic git host | 🛑 |
Getting started
GitHub
Prerequisite: Configure GitHub as an external identity provider. Permission syncing works with GitHub.com, GitHub Enterprise Cloud, and GitHub Enterprise Server. For organization-owned repositories, users that have read-only access (or above) via the following methods will have their access synced to Sourcebot:- Outside collaborators
- Organization members that are direct collaborators
- Organization members with access through team memberships
- Organization members with access through default organization permissions
- Organization owners.
- A GitHub external identity provider must be configured to (1) correlate a Sourcebot user with a GitHub user, and (2) to list repositories that the user has access to for User driven syncing.
- OAuth tokens must assume the
reposcope in order to use the List repositories for the authenticated user API during User driven syncing. Sourcebot will only use this token for reads.
GitLab
Prerequisite: Configure GitLab as an external identity provider. Permission syncing works with GitLab Self-managed and GitLab Cloud. Users with Guest role or above with membership to a group or project will have their access synced to Sourcebot. Both direct and indirect membership to a group or project will be synced with Sourcebot. For more details, see the GitLab docs. Notes:- A GitLab external identity provider must be configured to (1) correlate a Sourcebot user with a GitLab user, and (2) to list repositories that the user has access to for User driven syncing.
- OAuth tokens require the
read_apiscope in order to use the List projects for the authenticated user API during User driven syncing.
How it works
Permission syncing works by periodically syncing ACLs from the code host(s) to Sourcebot to build an internal mapping between Users and Repositories. This mapping is hydrated in two directions:- User driven : fetches the list of all repositories that a given user has access to.
- Repo driven : fetches the list of all users that have access to a given repository.
| Setting | Type | Default | Minimum |
|---|---|---|---|
experiment_repoDrivenPermissionSyncIntervalMs | number | 24 hours | 1 |
experiment_userDrivenPermissionSyncIntervalMs | number | 24 hours | 1 |