> ## 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.