> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub Sync User Credentials 集合

`githubSyncUserCredentials` 为每个为 GitHub Sync 关联了 GitHub 账户的用户保存一个文档。 它以加密形式存储用户的 OAuth 访问令牌。 该集合属于 `github-sync` web 模块（`services/web/modules/github-sync`）。schema 位于 `services/web/modules/github-sync/app/models/githubSyncUserCredentials.mjs`，所有访问都经过 `services/web/modules/github-sync/app/src/TokenManager.mjs`。

#### 字段

| 字段 | 类型 | 含义 | 来源 |
| - | - | - | - |
| `_id` | ObjectId | upsert 插入时由 Mongoose 设置。 | |
| `userId` | ObjectId | Overleaf 用户。必填。schema 写了 `unique: true`，但不会建立任何索引（见“索引”）；按 `userId` 的 upsert 保证每个用户只有一个文档。 | `githubSyncUserCredentials.mjs:8`, `TokenManager.mjs:44-48` |
| `github` | String | GitHub OAuth 访问令牌，使用 `@overleaf/access-token-encryptor` 加密。密码来自 `GITHUB_TOKEN_CIPHER_PASSWORD`；加密标签为 `GITHUB_TOKEN_CIPHER_LABEL`，默认 `2026.3-v3`。必填。 | `githubSyncUserCredentials.mjs:9`, `TokenManager.mjs:12-25` |
| `__v` | Number | Mongoose 版本键。schema 没有关闭它。 | Mongoose 默认 |

只存储访问令牌：OAuth 回调只保留 GitHub 响应中的 `access_token`（`services/web/modules/github-sync/app/src/GitHubApiClient.mjs:180-191`）。没有刷新令牌，也没有过期时间。

#### 写入方

| 代码 | 作用 |
| - | - |
| `TokenManager.mjs:42-58` (`saveUserToken`) | 对用户的加密令牌执行 upsert。用户重新关联时，被替换的令牌会在后台于 GitHub 上撤销。由 OAuth 回调调用（`services/web/modules/github-sync/app/src/GitHubSyncController.mjs:146`）。 |
| `TokenManager.mjs:61-76` (`removeUserToken`) | 在 GitHub 上撤销令牌（尽力而为），然后删除文档。在取消关联时（`GitHubSyncController.mjs:167`）以及已删除用户过期时（`services/web/modules/github-sync/index.mjs:66-68`）调用。 |

#### 读取方

| 代码 | 作用 |
| - | - |
| `TokenManager.mjs:36-40` (`getUserToken`) | 为每次 GitHub API 调用解密令牌：`services/web/modules/github-sync/app/src/GitHubSyncHandler.mjs`（例如 `:27`）和 `services/web/modules/github-sync/app/src/GitMerge.mjs:43`。没有文档或令牌无法解密时，抛出 `InvalidTokenError`，用户视为未关联（`GitHubSyncHandler.mjs:25-37`）。 |
| `services/web/modules/admin-tools/app/src/AdminUserListManager.mjs:393` | 检查用户是否有文档，用于管理面板中显示的集成。 |

#### 索引

| 名称 | 键 | 选项 | 迁移 |
| - | - | - | - |
| `_id_` | `_id: 1` | | default |

Mongoose 的 `autoIndex` 已关闭（`services/web/app/src/infrastructure/Mongoose.mjs:7`），因此 schema 中 `userId` 上的 `unique: true` 不会创建任何索引。 `tools/migrations/20190912145011_create_githubSyncUserCredentials_indexes.mjs`（上游的 `user_id`）只带有 `saas` 标签，不会在 CE 中运行。

#### 说明

* 更改 `GITHUB_TOKEN_CIPHER_PASSWORD` 会使已存储的令牌无法读取。这些用户在重新关联之前都视为未关联。
* 已删除的用户会保留该文档，直到该用户过期。


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