Admin API สำหรับองค์กร Enterprise

ในเอกสารช่วยเหลือนี้

ทำงานของผู้ดูแลระบบด้วยโค้ดแทนการปรับตั้งค่า

หมายเหตุ: ฟีเจอร์นี้มีให้ใช้งานเฉพาะในแพ็คเกจ Enterprise เท่านั้น และเฉพาะเจ้าขององค์กรเท่านั้นที่สามารถตั้งค่าได้

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

คุณสามารถตั้งค่านี้ได้ในการตั้งค่าองค์กร โดยสร้างบอทผู้ดูแลสำหรับองค์กร จากนั้นกำหนดโทเค็นที่มีเฉพาะสิทธิ์ที่จำเป็นให้บอทนั้น

ใครสามารถใช้ Admin API ได้บ้าง

องค์กรของคุณจำเป็นต้องใช้แพ็คเกจ Enterprise
คุณต้องเป็นเจ้าขององค์กร
สิ่งนี้สร้างขึ้นสำหรับทีมผู้ดูแลระบบ ทีมไอที ทีมรักษาความปลอดภัย และทีมปฏิบัติตามกฎระเบียบ สมาชิกและผู้ใช้ชั่วคราวจะไม่สังเกตเห็นการเปลี่ยนแปลงใดๆ ในการทำงานประจำวันของพวกเขา

ตั้งค่าการเชื่อมต่อและโทเค็นของผู้ดูแลระบบ

เปิดตัวสลับพื้นที่ทำงานของคุณแล้วเลือก จัดการองค์กร
ไปที่ ทั่วไป จากนั้นเปิด จัดการโทเค็น Admin API ระดับองค์กร
เลือก สร้างการเชื่อมต่อ
ตั้งชื่อการเชื่อมต่อที่ทีมของคุณจะจดจำได้ เช่น “ระบบอัตโนมัติเพื่อการปฏิบัติตามกฎระเบียบ” และเลือกเฉพาะสิทธิ์ที่จำเป็นเท่านั้น หากการเชื่อมต่อใช้สำหรับการส่งออกเพียงอย่างเดียว อย่าให้สิทธิ์ในการบล็อคแก่การเชื่อมต่อนั้น
เลือก สร้างโทเค็น จากนั้นคัดลอกโทเค็นและบันทึกไว้ในตัวจัดการความลับ (secrets manager) ที่ทีมของคุณใช้งานอยู่แล้ว

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

เคล็ดลับ: ให้การทำงานอัตโนมัติแต่ละรายการมีการเชื่อมต่อและโทเค็นของตนเอง หากจำเป็นต้องปิดโทเค็นรายการหนึ่ง การทำงานอัตโนมัติที่เหลือของคุณจะยังคงทำงานต่อไป

รักษาโทเค็นของคุณให้ปลอดภัย

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

ดูกิจกรรมผู้ดูแล API ในบันทึกการตรวจสอบของคุณ

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

การแก้ไขปัญหา

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

จะดูรายละเอียดปลายทางได้ที่ไหน

สำหรับรูปแบบคำขอ พารามิเตอร์ และตัวอย่างโค้ด โปรดดู ข้อมูลอ้างอิงผู้ดูแล API ในเอกสารสำหรับนักพัฒนา

คำถามที่พบบ่อย

สิ่งนี้เหมือนกับโทเค็นการเชื่อมต่อ Notion API หรือไม่?

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

สิ่งนี้มาแทนที่การตั้งค่าองค์กรหรือไม่?

ไม่ สิ่งที่คุณทำได้ด้วย API ผู้ดูแลก็สามารถทำได้ด้วยตนเองผ่านการตั้งค่าองค์กรแล้ว API มีไว้สำหรับทำงานซ้ำในปริมาณมาก

ฉันสามารถจำกัดโทเค็นให้ใช้เฉพาะกับที่อยู่ IP บางแห่งได้หรือไม่?

ยังไม่ได้ในขณะนี้ ข้อจำกัดที่อยู่ IP จะใช้กับผู้คนที่ลงชื่อเข้าใช้ ไม่ใช่กับโทเค็นผู้ดูแลระบบ