プロバイダーの資格情報 (機能) | Inbox Manager API ドキュメント

プロバイダーの資格情報

プロバイダー資格情報機能は、アカウントを電子メールプロバイダーに接続するために使用されるサインインの詳細を定義します。これにより、サインインし、資格情報を保存し、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`	1 つの認証情報メタデータレコードを取得する
資格情報を更新する	`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"
}

パブリックペイロードは、メタデータとマスクされた ID のみを公開します。

故障モードと制御

無効なホスト、ポート、またはセキュリティ/認証の組み合わせは作成時または更新時に拒否され、ダウンストリームの同期ジョブや送信ジョブが実行される前にテストの失敗が表面化します。シークレット値は読み取りペイロードから除外され、資格情報のローテーションは、無関係な操作中の暗黙的な変更ではなく、明示的かつ監査可能です。