提供商凭证

提供商凭证

提供商凭据功能定义用于将您的帐户连接到电子邮件提供商的登录详细信息。 它为您提供了清晰的流程：登录、保存凭据，然后安全地使用 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-提供商凭据和连接。