ไทย
  • logto
  • management-api
  • api
  • machine-to-machine
  • organization
  • user-profile
  • user-search
  • audit-log
  • migration

สำรวจศักยภาพเต็มรูปแบบของ Logto Management API

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

Guamian
Guamian
Product & Design

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

Logto Management API คืออะไร

Logto Management API คือชุด API สำเร็จรูปอันทรงพลังที่ให้นักพัฒนาเต็มรูปแบบในการปรับแต่งการใช้งานให้เหมาะสมกับความต้องการของผลิตภัณฑ์และเทคโนโลยี

มันถูกรวมอยู่ในรายการแหล่ง API และไม่สามารถลบหรือแก้ไขได้ ทุกสิ่งที่คุณทำได้ใน Logto Admin Console ก็สามารถทำได้ด้วย Logto Management API

รหัสประจำตัวของมันคือรูปแบบ https://[tenant-id].logto.app/api

Logto management API

Logto management API - 2

มันรวมถึงสิทธิ์ all เป็นค่าเริ่มต้น เมื่อ Logto เติบโตขึ้น เราจะทำให้สิทธิ์มีความละเอียดมากขึ้น

ด้วย Logto Management API คุณสามารถเข้าถึงบริการ backend ของ Logto ที่แข็งแกร่ง ซึ่งสามารถขยายได้สูงและสามารถใช้งานได้ในหลากหลายสถานการณ์ เพื่อเรียนรู้เกี่ยวกับ API ที่ใช้ได้ กรุณาเยี่ยมชม Logto API references

สถานการณ์ทั่วไปในการใช้ Management API

นักพัฒนาของเราได้ใช้ API การจัดการของเราเพื่อพัฒนาฟีเจอร์เพิ่มเติมหลายอย่าง เราเชื่อว่า API ของเรามีความสามารถสูงและสามารถสนับสนุนความต้องการที่หลากหลายของคุณ ตัวอย่างเช่น สถานการณ์ที่ไม่สามารถทำได้ด้วย Logto Admin Console แต่สามารถดำเนินการผ่าน Management API

ใช้โปรไฟล์ผู้ใช้กับ UI ของคุณเอง

Logto ปัจจุบันยังไม่ได้จัดเตรียมโซลูชัน UI สำเร็จรูปสำหรับโปรไฟล์ผู้ใช้ เรารับรู้ว่าโปรไฟล์ผู้ใช้มีความเกี่ยวข้องอย่างใกล้ชิดกับคุณสมบัติของธุรกิจและผลิตภัณฑ์ ในขณะที่เราทำงานเพื่อค้นหาวิธีที่ดีที่สุด เราแนะนำให้ใช้ API ของเราเพื่อสร้างโซลูชันของคุณเอง ตัวอย่างเช่น คุณสามารถใช้ interaction API, profile API และ verification code API ของเราในการพัฒนาโซลูชันที่ตรงกับความต้องการของคุณ เราได้เตรียมหน้าที่เฉพาะ User Profile สำหรับบทแนะนำและคู่มือ

ตัวอย่างที่น่าสนใจคือฟีเจอร์โปรไฟล์ผู้ใช้ของ Logto Cloud ที่สร้างขึ้นโดยใช้ Logto Management API

Account settings

ใช้การจัดการองค์กรกับ UI ของคุณเอง

ถ้าคุณกำลังใช้ ฟีเจอร์การจัดการองค์กร ในการสร้างแอปหลายผู้เช่า คุณอาจจะต้องใช้ Logto management API สำหรับงานเช่นคำเชิญองค์กรและการจัดการสมาชิก

เช่นเดียวกัน Logto Cloud invitation และ collaboration feature ก็สร้างโดยใช้ Logto Management API เช่นกัน

Organization

เชิญสมาชิกเข้าสู่องค์กร

เพื่อขยายกรณีนั้น สำหรับผลิตภัณฑ์ SaaS ของคุณที่มีทั้งผู้ดูแลระบบและสมาชิกในผู้เช่า Logto management API สามารถช่วยให้คุณสร้างพอร์ทัลผู้ดูแลที่ตรงตามความต้องการธุรกิจของคุณได้ ตรวจสอบ นี้ สำหรับข้อมูลเพิ่มเติม

ค้นหาผู้ใช้ขั้นสูง

Logto Admin Console รองรับฟังก์ชันการค้นหาและกรองพื้นฐาน หากคุณต้องการตัวเลือกขั้นสูงเพิ่มเติมเพื่อตอบสนองการจัดการผู้ใช้ของคุณกับความต้องการทางธุรกิจของคุณ คุณสามารถใช้ Logto Management API รองรับตัวเลือกการค้นหาขั้นสูง เช่น:

  1. การค้นหาคร่าว ๆ
  2. การจับคู่ที่ตรงกัน
  3. ความไวต่อกรณีตัวอักษร
  4. การระบุฟิลด์

ดูบทแนะนำและคู่มือ Advanced User Search

ใช้บันทึกของ Logto เพื่อสร้างบริการของคุณเอง

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

Audit logs

ด้วยการใช้ management API คุณสามารถเข้าถึงข้อมูลบันทึกการตรวจสอบแบบเรียลไทม์ นี่จะช่วยให้คุณออกแบบแบบจำลองสคีมาและแดชบอร์ดของคุณเองโดยการใช้ข้อมูลบันทึกที่ได้รับจาก Logto

ย้ายและนำเข้าผู้ใช้ไปยัง Logto

การใช้ Management API สามารถช่วยให้คุณนำเข้าข้อมูลผู้ใช้ได้อย่างง่ายดาย โดยเฉพาะเมื่อคุณต้องการ ย้ายข้อมูล ไปที่ Logto

หลังจากที่คุณเตรียมข้อมูลผู้ใช้และตั้งค่า การแฮชรหัสผ่าน และ สคีมาผู้ใช้ ตั้งค่าการเชื่อมต่อ Management API และเราจะเรียกใช้ สร้างผู้ใช้ API เพื่อนำเข้าข้อมูลผู้ใช้ สำหรับข้อมูลเพิ่มเติมเกี่ยวกับการย้ายข้อมูล ดูเอกสาร นี้

วิธีการเข้าถึง Logto Management API

สร้างแอป M2M

เลือกประเภทแอป M2M และเริ่มต้นกระบวนการสร้าง หลังจากสร้างแล้ว คุณจะถูกนำไปยังโมดูลที่คุณสามารถกำหนดบทบาทเครื่องต่อเครื่อง

หลังจากให้ชื่อและคำอธิบาย คุณจะเห็นโมดูลที่ขอให้คุณกำหนดบทบาท โมดูลนี้มีบทบาท M2M ทั้งหมด บทบาทที่ระบุโดยไอคอน Logto หมายความว่าบทบาทเหล่านี้รวมถึงสิทธิ์ Logto management API

การกำหนดบทบาท M2M รวมถึงสิทธิ์ Logto management API สำหรับแอป M2M ของคุณ

กำหนดบทบาท M2M

ทำไมต้องใช้การสื่อสารเครื่องต่อเครื่องและกำหนดบทบาทเครื่องต่อเครื่อง?

ทำไม Logto จึงอนุญาตให้มีการสื่อสาร M2M (Machine-to-Machine) เพื่อเรียก Logto Management API แทนการใช้คีย์ API?

Logto จัดการตัวตนของลูกค้าและปฏิบัติตามมาตรฐานเปิดอย่างเคร่งครัด เช่น OAuth 2.0 และ OpenID Connect โทเค็น M2M เสนอการโต้ตอบเซิร์ฟเวอร์ต่อเซิร์ฟเวอร์ที่ปลอดภัยด้วยขอบเขตที่เฉพาะเจาะจง ให้ความปลอดภัยที่ดีกว่าคีย์ API ที่เป็นเอกภาพ ขณะที่คีย์ API ไม่หมดอายุและมีความเสี่ยงสูงเมื่อถูกประนีประนอม โทเค็น M2M มีเวลาหมดอายุที่กำหนด จำกัดช่องทางสำหรับการใช้งานที่ไม่สมควร

ใน Logto เราใช้การควบคุมการเข้าถึงตามบทบาท (RBAC) เพื่อปกป้องและจัดการการเข้าถึงไปยัง Logto Management API แผนภาพเอนทิตีนี้แสดงวิธีการทำงาน

ความสัมพันธ์ของสิทธิ์ API ทรัพยากร บทบาท และแอปพลิเคชันเครื่องต่อเครื่อง

ความสัมพันธ์ของสิทธิ์ API ทรัพยากร บทบาท และแอปพลิเคชันเครื่องต่อเครื่อง

เรียกข้อมูลโทเค็นการเข้าถึง

พื้นฐานเกี่ยวกับการขอโทเค็นการเข้าถึง

แอป M2M ทำคำขอ POST ไปยังโทเค็น endpoint เพื่อเรียกข้อมูลโทเค็นการเข้าถึงโดยเพิ่มพารามิเตอร์ดังต่อไปนี้โดยใช้รูปแบบ application/x-www-form-urlencoded ในร่างเอนทิตีคำขอ HTTP:

  • grant_type: ต้องตั้งค่าเป็น client_credentials
  • resource: ตัวชี้วัดทรัพยากรที่คุณต้องการเข้าถึง
  • scope: ขอบเขตของคำขอการเข้าถึง

นอกจากนี้คุณยังจำเป็นต้องรวมรายละเอียด M2M ของคุณสำหรับโทเค็น endpoint เพื่อยืนยันแอป M2M ของคุณ ซึ่งดำเนินการโดยการเพิ่มหัวข้อ Authorization โดยใช้ การยืนยันแบบพื้นฐาน โดยที่ชื่อผู้ใช้คือไอดีแอป ส่วนรหัสผ่านคือความลับของแอป

คุณสามารถค้นหาไอดีแอปและความลับของแอปจากหน้ารายละเอียดแอป M2M ของคุณ:

ข้อมูลประจำตัวแอป

ตัวอย่างของคำขอโทเค็นการเข้าถึง Logto Management API คือ:

เรียกโทเค็นการเข้าถึงสำหรับ Logto Management API

Logto จัดหาทรัพยากร "Logto Management API" แบบฝังตัว เป็นทรัพยากรแบบอ่านอย่างเดียวที่มีสิทธิ์ all ในการเข้าถึง Logto Management API คุณสามารถเห็นได้จากรายการทรัพยากร API ของคุณ ตัวชี้วัด API ของทรัพยากรคือรูปแบบ https://{YOUR_TENANT_ID}.logto.app/api และนี่จะเป็นค่าทรัพยากรของคุณที่ใช้ในร่างคำขอโทเค็นการเข้าถึง

สถานะ Management API

ก่อนเข้าถึง Logto Management API ตรวจสอบให้แน่ใจว่าแอป M2M ของคุณได้รับมอบหมายกับบทบาท M2M ที่มีสิทธิ์ all จากทรัพยากร "Logto Management API" แบบฝังตัวนี้

ตอนนี้ รวมทุกอย่างและส่งคำขอ:

การตอบสนองของโทเค็น

ตัวอย่างร่างการตอบสนองที่สำเร็จคือ:

เข้าถึง Logto Manage API โดยใช้ Access Tokenhttps://docs.logto.io/quick-starts/m2m/#access-resource-using-access-token

คุณอาจสังเกตเห็นการตอบสนองของโทเค็นมีฟิลด์ token_type ซึ่งถูกตั้งไว้เป็น Bearer ดังนั้นคุณควรนำ Access Token ใส่ในฟิลด์ Authorization ของ HTTP headers ด้วยรูปแบบ Bearer (Bearer YOUR_TOKEN)

ตอนนี้คุณสามารถเข้าถึง Logto Management API โดยทำคำขอไปยัง Logto Management API endpoint https://[your-tenant-id].logto.app/api เพื่อดูแอปพลิเคชันทั้งหมดใน Logto

แหล่งข้อมูลที่เกี่ยวข้อง

นี่คือแหล่งข้อมูลที่เกี่ยวข้องที่เจาะลึกถึงข้อมูลเชิงลึกและกลยุทธ์ที่เรามีในอดีตสำหรับการใช้ Logto Management API วัสดุเหล่านี้ครอบคลุมหลายแง่มุม รวมถึงแนวปฏิบัติที่ดีที่สุด เคล็ดลับการใช้งาน และกรณีการใช้งาน เพื่อช่วยให้คุณได้รับประโยชน์สูงสุดจาก Logto Management API ในโครงการของคุณ

โต้ตอบกับ Management API วันนี้