IM
ES
Inicio de documentación
Menú
Funciones

Credenciales de proveedor

Ciclo de vida de las credenciales de inicio de sesión para acceder al proveedor de correo electrónico.

inbox-managercredentialsencryption

Credenciales de proveedor

La función de credenciales del proveedor define los detalles de inicio de sesión utilizados para conectar su cuenta a un proveedor de correo electrónico. Le brinda un flujo claro: inicie sesión, guarde las credenciales y luego use IMAP y SMTP de forma segura.

Por qué esto importa

Esta característica mantiene los valores secretos fuera de las respuestas API estándar y al mismo tiempo expone los campos que los clientes necesitan para operar de forma segura. Realiza operaciones explícitas de validación, rotación y eliminación, de modo que la higiene de las credenciales no dependa de efectos secundarios en la sincronización o los flujos de envío.

Flujo central

Después de iniciar sesión, una persona que llama autorizada crea detalles de credenciales y valores secretos y luego valida la conectividad a través del endpoint de prueba. Los flujos de la bandeja de entrada hacen referencia a los ID de credenciales para las operaciones IMAP y SMTP, y las credenciales se rotan o eliminan explícitamente a medida que cambian los proveedores o los requisitos de seguridad.

Operaciones

Operación Punto final Objetivo
Crear credencial POST /api/accounts/:account_id/provider-credentials Registrar la credencial de proveedor con ámbito de cuenta
Listar credenciales GET /api/accounts/:account_id/provider-credentials Obtener metadatos de credenciales de cuenta
Credenciales de búsqueda POST /api/accounts/:account_id/provider-credentials/search Consultar credenciales por filtro
Obtener credencial GET /api/provider-credentials/:provider_credential_id Recuperar un registro de metadatos de credenciales
Actualizar credencial PATCH /api/provider-credentials/:provider_credential_id Modificar campos de credenciales no secretas
Eliminar credencial DELETE /api/provider-credentials/:provider_credential_id Eliminar credencial del uso de la cuenta
credencial de prueba POST /api/provider-credentials/:provider_credential_id/test Ejecutar validación de conectividad/autenticación
Rotar credencial POST /api/provider-credentials/:provider_credential_id/rotate Reemplazar material secreto activo

Datos clave y estado

{
  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"
}

Las cargas públicas solo exponen metadatos e identidades enmascaradas.

Modos de falla y controles

Las combinaciones de host, puerto o seguridad/autenticación no válidas se rechazan en el momento de la creación o actualización, y las fallas de prueba surgen antes de que se ejecuten los trabajos de envío o sincronización descendente. Los valores secretos están excluidos de las cargas útiles de lectura y la rotación de credenciales es explícita y auditable en lugar de ser una mutación implícita durante operaciones no relacionadas.

Relacionado

Credencial de proveedor, 03-credenciales-de-proveedor-y-conectividad.