提供者憑證

提供者憑證

提供者憑證功能定義用於將您的帳戶連接到電子郵件提供者的登入詳細資訊。 它為您提供了清晰的流程：登入、儲存憑證，然後安全地使用 IMAP 和 SMTP。

為什麼這很重要

此功能將秘密值排除在標準 API 回應之外，同時公開用戶端安全操作所需的欄位。它使驗證、輪換和刪除顯式操作，因此憑證衛生不依賴同步或發送流中的副作用。

核心流程

登入後，授權呼叫者建立憑證詳細資訊和秘密值，然後透過測試端點驗證連線。收件匣流會引用 IMAP 和 SMTP 操作的憑證 ID，並且憑證會隨著提供者或安全要求的變更而明確輪替或刪除。

操作

營運	端點	目的
建立憑證	POST /api/accounts/:account_id/provider-credentials	註冊帳戶範圍的提供者憑證
列出憑證	GET /api/accounts/:account_id/provider-credentials	取得帳戶憑證元資料
搜尋憑證	POST /api/accounts/:account_id/provider-credentials/search	透過篩選器查詢憑證
取得憑證	GET /api/provider-credentials/:provider_credential_id	檢索一項憑證元資料記錄
更新憑證	PATCH /api/provider-credentials/:provider_credential_id	修改非秘密憑證欄位
刪除憑證	DELETE /api/provider-credentials/:provider_credential_id	從帳戶使用中刪除憑證
測試憑證	POST /api/provider-credentials/:provider_credential_id/test	運行連線/驗證驗證
輪換憑證	POST /api/provider-credentials/:provider_credential_id/rotate	替換活性秘密材料

關鍵數據和狀態

{
  id: "pc_...",
  account_id: "acc_...",
  provider_kind: "imap" | "smtp",
  host: "mail.example.com",
  port: 993,
  security_mode: "ssl_tls",
  auth_kind: "password",
  username_masked: "u***@example.com"
}

公共有效負載僅公開元資料和隱藏身分。

故障模式與控制

無效的主機、連接埠或安全性/驗證組合在建立或更新時會被拒絕，並且在下游同步或傳送作業執行之前會出現測試失敗。秘密值被排除在讀取有效負載之外，並且憑證輪換是明確且可審計的，而不是在不相關操作期間成為隱式突變。

相關

提供者憑證、03-提供者憑證和連接。