ข้อมูลประจำตัวของผู้ให้บริการ

#ข้อมูลประจำตัวของผู้ให้บริการ

คุณสมบัติข้อมูลประจำตัวของผู้ให้บริการจะกำหนดรายละเอียดการลงชื่อเข้าใช้ที่ใช้ในการเชื่อมต่อบัญชีของคุณกับผู้ให้บริการอีเมล โดยให้ขั้นตอนที่ชัดเจนแก่คุณ: ลงชื่อเข้าใช้ บันทึกข้อมูลรับรอง จากนั้นใช้ IMAP และ SMTP อย่างปลอดภัย

ทำไมเรื่องนี้ถึงสำคัญ

คุณสมบัตินี้จะเก็บค่าความลับไม่ให้อยู่ในการตอบสนองของ API มาตรฐาน ในขณะเดียวกันก็เปิดเผยฟิลด์ที่ลูกค้าจำเป็นต้องดำเนินการอย่างปลอดภัย ทำให้การตรวจสอบความถูกต้อง การหมุนเวียน และการลบดำเนินการอย่างชัดเจน ดังนั้นการรักษาความปลอดภัยของข้อมูลรับรองจึงไม่ขึ้นอยู่กับผลข้างเคียงในการซิงค์หรือขั้นตอนการส่ง

คอร์โฟลว์

หลังจากลงชื่อเข้าใช้ ผู้โทรที่ได้รับอนุญาตจะสร้างรายละเอียดข้อมูลรับรองและค่าลับ จากนั้นตรวจสอบการเชื่อมต่อผ่านจุดสิ้นสุดการทดสอบ โฟลว์กล่องจดหมายอ้างอิง ID ข้อมูลรับรองสำหรับการดำเนินการ IMAP และ SMTP และข้อมูลรับรองจะถูกหมุนเวียนหรือลบอย่างชัดเจนเมื่อผู้ให้บริการหรือข้อกำหนดด้านความปลอดภัยมีการเปลี่ยนแปลง

การดำเนินงาน

การดำเนินงาน	จุดสิ้นสุด	วัตถุประสงค์
สร้างข้อมูลรับรอง	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-ผู้ให้บริการ-ข้อมูลรับรองและการเชื่อมต่อ