จัดเตรียมผู้ใช้และกลุ่มด้วย SCIM

SCIM API ของ Notion ช่วยให้คุณสามารถทำสิ่งต่อไปนี้ได้:

• สร้างและลบสมาชิกในพื้นที่ทำงานของคุณ

• อัปเดตข้อมูลโพรไฟล์ของสมาชิก

• เรียกดูข้อมูลสมาชิกในพื้นที่ทำงานของคุณ

• ค้นหาสมาชิกตามอีเมลหรือชื่อ

• สร้างและลบกลุ่มในพื้นที่ทำงานของคุณ

• เพิ่มและลบสมาชิกในกลุ่ม

• เรียกดูข้อมูลกลุ่มในพื้นที่ทำงานของคุณ

• ค้นหากลุ่มตามชื่อ

ปัจจุบันเรารองรับ Okta, OneLogin, Rippling และแอปพลิเคชัน SCIM แบบกำหนดเอง หากคุณใช้ผู้ให้บริการข้อมูลประจำตัวรายอื่น โปรดแจ้งให้เราทราบ ดูคำแนะนำสำหรับการตั้งค่าผู้ให้บริการข้อมูลประจำตัวสำหรับแอปเฉพาะ ที่นี่ →

ในการใช้ SCIM กับ Notion:

• พื้นที่ทำงานของคุณต้องอยู่บนแพ็คเกจ Enterprise

• ผู้ให้บริการข้อมูลประจำตัว (IdP) ของคุณต้องรองรับโปรโตคอล SAML 2.0 ดูคำแนะนำสำหรับการตั้งค่าผู้ให้บริการข้อมูลประจำตัวสำหรับแอปเฉพาะ ที่นี่ →

• เจ้าของพื้นที่ทำงานต้องกำหนดค่า SCIM สำหรับพื้นที่ทำงาน Notion นั้นๆ

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

เฉพาะ เจ้าขององค์กร ในแพ็คเกจ Enterprise เท่านั้นที่สามารถสร้างและดูโทเค็น SCIM API ได้ ในการสร้างโทเค็น SCIM API:

1. เปิดตัวสลับพื้นที่ทำงานและเลือก จัดการองค์กร คุณอาจต้อง ตั้งค่าองค์กร ก่อนหากคุณยังไม่ได้ดำเนินการ ดูข้อมูลเพิ่มเติม ที่นี่ →

2. ในแท็บ ทั่วไป ของการควบคุมระดับองค์กรของคุณ ให้เลือก > ถัดจาก การจัดเตรียม SCIM

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

นอกจากนี้ โทเค็นที่ใช้งานอยู่ยังสามารถถูกเพิกถอนโดยเจ้าของพื้นที่ทำงานคนใดก็ได้ในพื้นที่ทำงานนั้น ในการเพิกถอนโทเค็น ให้คลิก 🗑 ที่อยู่ข้างโทเค็นนั้นๆ

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

การผสานการทำงาน SCIM และการจัดเตรียมผู้ใช้ใดๆ ที่อาศัยโทเค็นที่ถูกเพิกถอนจะถูกปิดใช้งานจนกว่าจะถูกแทนที่ด้วยโทเค็นที่ใช้งานได้

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

1. เปิดตัวสลับพื้นที่ทำงานของคุณแล้วเลือก จัดการองค์กร

2. ในแท็บ ทั่วไป ให้เปิด ระงับอีเมลคำเชิญจากการจัดเตรียม SCIM หากคุณไม่ต้องการส่งอีเมลถึงผู้ใช้

ในการจัดเตรียม สมาชิกแบบจำกัดสิทธิ ผ่าน SCIM คุณต้องตั้งค่าแอตทริบิวต์ 'role' ของ SCIM เป็น 'restricted_member':

\"urn:ietf:params:scim:schemas:extension:notion:2.0:User\": { role: string // \"owner\" | \"membership_admin\" | \"member\" | \"restricted_member\" }

ในการเปลี่ยนสถานะผู้ใช้ชั่วคราวบนหน้าให้เป็นสมาชิกแบบจำกัดสิทธิผ่าน SCIM คุณต้องใช้ POST /scim/v2/Users

• GET /ServiceProviderConfig

  • GET

  • เรียกดูคำอธิบายของคุณสมบัติข้อมูลจำเพาะ SCIM ที่มีอยู่

  • กำหนดไว้ใน ส่วนที่ 5 ของข้อกำหนดโปรโตคอล SCIM

• GET /ResourceTypes

  • GET

  • เรียกดูรายการประเภททรัพยากร SCIM ที่มีอยู่

  • กำหนดไว้ใน ส่วนที่ 6 ของข้อกำหนดโปรโตคอล SCIM

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

• GET /Users

  • GET

  • เรียกดูรายการสมาชิกพื้นที่ทำงานแบบแบ่งหน้า

  • คุณสามารถแบ่งหน้าโดยใช้พารามิเตอร์ startIndex และ count โปรดทราบว่า startIndex เริ่มต้นที่ 1 และ count มีค่าสูงสุดที่ 100

  • คุณสามารถกรองผลลัพธ์ด้วยพารามิเตอร์ filter แอตทริบิวต์ที่ถูกต้องในการกรองคือ email, given_name และ family_name เช่น GET

  • โปรดทราบว่า given_name และ family_name มีความไวต่อความแตกต่างของตัวพิมพ์ใหญ่และตัวพิมพ์เล็ก และอีเมลจะถูกแปลงเป็นตัวพิมพ์เล็ก

• GET /Users/

  • GET

  • ดึงข้อมูลสมาชิกพื้นที่ทำงานที่ระบุโดยใช้ Notion user ID ของสมาชิกนั้น ซึ่งจะเป็น UUID ที่มี 32 อักขระในรูปแบบดังนี้: 00000000-0000-0000-0000-000000000000

  • โปรดทราบว่า meta.created และ meta.lastModified ไม่ได้สะท้อนค่าการประทับเวลาที่มีความหมาย

• POST /Users

  • POST

  • หากผู้ใช้ที่คุณกำลังเพิ่มมีบัญชีผู้ใช้ Notion ที่มีอีเมลเดียวกันอยู่แล้ว พวกเขาจะถูกเพิ่มลงในพื้นที่ทำงานของคุณ

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

  • SCIM API จะอ่านพร็อพเพอร์ตี้รูปโปรไฟล์เมื่อสร้างผู้ใช้ แต่จะไม่ทำในการอัปเดตในอนาคต

• PATCH /Users/

  • PATCH

  • อัปเดตผ่านชุดการดำเนินการ และส่งคืนบันทึกที่อัปเดตแล้วของผู้ใช้

• PUT /Users/

  • PUT

  • อัปเดตและส่งคืนบันทึกที่อัปเดตแล้วของผู้ใช้

• DELETE /Users/

  • DELETE

  • นำผู้ใช้ออกจากพื้นที่ทำงานของคุณ ผู้ใช้จะถูกออกจากระบบทุกเซสชันที่ใช้งานอยู่

    • บัญชีผู้ใช้ไม่สามารถลบผ่าน SCIM ได้ การลบบัญชีต้องทำด้วยตนเอง

    • การนำผู้ใช้ออกจากพื้นที่ทำงานของคุณสามารถทำได้โดยการตั้งค่าแอตทริบิวต์ผู้ใช้ active เป็น false โดยการส่งคำขอ PATCH /Users/ หรือ PUT /Users/

    • เจ้าของพื้นที่ทำงานที่สร้างโทเค็นบอท SCIM ไม่สามารถถูกลบผ่าน API ได้ เมื่อเจ้าของพื้นที่ทำงานถูกลบผ่าน SCIM API โทเค็นใดๆ ที่พวกเขาสร้างขึ้นจะถูกเพิกถอน และการผสานการทำงานใดๆ ที่ใช้บอทนั้นจะใช้งานไม่ได้

• GET /Groups

  • GET

  • ดึงรายการกลุ่มพื้นที่ทำงานแบบแบ่งหน้า

  • คุณสามารถแบ่งหน้าโดยใช้พารามิเตอร์ startIndex และ count โปรดทราบว่า startIndex เริ่มต้นที่ 1 และ count มีค่าสูงสุดที่ 100 เช่น GET

    • หากไม่มีการใช้การแบ่งหน้า จะมีการส่งคืนกลุ่มพื้นที่ทำงานสูงสุด 100 กลุ่มในการร้องขอหนึ่งครั้ง

  • คุณสามารถกรองผลลัพธ์ได้ด้วยพารามิเตอร์ filter กลุ่มสามารถกรองได้โดยใช้แอตทริบิวต์ displayName เช่น GET

• GET /Groups/

  • GET

  • ดึงข้อมูลกลุ่มพื้นที่ทำงานเฉพาะโดยใช้ Notion group ID ของกลุ่มนั้น ซึ่งจะเป็น UUID ที่มี 32 อักขระในรูปแบบต่อไปนี้: 00000000-0000-0000-0000-000000000000

• POST /Groups

  • POST

  • สร้างกลุ่มพื้นที่ทำงานใหม่

• PATCH /Groups/

  • PATCH

  • อัปเดตกลุ่มพื้นที่ทำงานผ่านชุดการดำเนินการต่างๆ

• PUT /Groups/

  • PUT

  • อัปเดตกลุ่มพื้นที่ทำงาน

• DELETE /Groups/

  • DELETE

  • ลบกลุ่มพื้นที่ทำงาน