Kredensial Penyedia
Fitur kredensial penyedia menentukan detail masuk yang digunakan untuk menghubungkan akun Anda ke penyedia email. Ini memberi Anda alur yang jelas: masuk, simpan kredensial, lalu gunakan IMAP dan SMTP dengan aman.
Mengapa Ini Penting
Fitur ini menjaga nilai rahasia dari respons API standar sekaligus mengekspos bidang yang dibutuhkan klien untuk beroperasi dengan aman. Ini membuat operasi validasi, rotasi, dan penghapusan menjadi eksplisit sehingga kebersihan kredensial tidak bergantung pada efek samping dalam sinkronisasi atau aliran pengiriman.
Aliran Inti
Setelah masuk, pemanggil resmi membuat detail kredensial dan nilai rahasia, lalu memvalidasi konektivitas melalui endpoint pengujian. Alur kotak masuk mereferensikan ID kredensial untuk operasi IMAP dan SMTP, dan kredensial dirotasi atau dihapus secara eksplisit seiring perubahan penyedia atau persyaratan keamanan.
Operasi
| Operasi | Endpoint | Tujuan |
|---|---|---|
| Buat kredensial | POST /api/accounts/:account_id/provider-credentials |
Daftarkan kredensial penyedia cakupan akun |
| Daftar kredensial | GET /api/accounts/:account_id/provider-credentials |
Ambil metadata kredensial akun |
| Cari kredensial | POST /api/accounts/:account_id/provider-credentials/search |
Kredensial kueri berdasarkan filter |
| Dapatkan kredensial | GET /api/provider-credentials/:provider_credential_id |
Ambil satu catatan metadata kredensial |
| Perbarui kredensial | PATCH /api/provider-credentials/:provider_credential_id |
Ubah bidang kredensial non-rahasia |
| Hapus kredensial | DELETE /api/provider-credentials/:provider_credential_id |
Hapus kredensial dari penggunaan akun |
| Uji kredensial | POST /api/provider-credentials/:provider_credential_id/test |
Jalankan validasi konektivitas/autentikasi |
| Putar kredensial | POST /api/provider-credentials/:provider_credential_id/rotate |
Gantikan materi rahasia yang aktif |
Data dan Status Utama
{
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"
}Muatan publik hanya mengekspos metadata dan identitas yang disamarkan.
Mode dan Kontrol Kegagalan
Kombinasi host, port, atau keamanan/autentikasi yang tidak valid ditolak pada waktu pembuatan atau pembaruan, dan kegagalan pengujian muncul sebelum sinkronisasi downstream atau tugas pengiriman dijalankan. Nilai rahasia dikecualikan dari payload baca, dan rotasi kredensial bersifat eksplisit dan dapat diaudit, bukan menjadi mutasi implisit selama operasi yang tidak terkait.
Terkait
Kredensial-Penyedia, 03-kredensial-penyedia-dan-konektivitas.