Provisikan pengguna & grup dengan SCIM

API SCIM Notion memungkinkan Anda untuk melakukan hal berikut:

• Buat dan hapus anggota di ruang kerja Anda.

• Perbarui informasi profil anggota.

• Ambil anggota di ruang kerja Anda.

• Temukan anggota menurut email atau nama.

• Buat dan hapus grup di ruang kerja Anda.

• Tambahkan dan hapus anggota dalam grup.

• Ambil grup di ruang kerja Anda.

• Temukan grup menurut nama.

Saat ini kami mendukung Okta, OneLogin, Rippling, dan aplikasi SCIM kustom. Jika Anda menggunakan Penyedia Identitas lain, beri tahu kami. Lihat Instruksi untuk pengaturan Penyedia Identitas untuk aplikasi tertentu di sini →

Untuk menggunakan SCIM dengan Notion:

• Ruang kerja Anda harus menggunakan Paket Perusahaan.

• Penyedia Identitas (IdP) Anda harus mendukung protokol SAML 2.0. Lihat Instruksi untuk pengaturan Penyedia Identitas untuk aplikasi tertentu di sini →

• Pemilik ruang kerja harus mengonfigurasi SCIM untuk ruang kerja Notion tersebut.

• Anda harus telah memverifikasi kepemilikan atas domain email jika ingin menggunakan SCIM untuk mengubah nama atau alamat email pengguna. Pelajari selengkapnya tentang verifikasi domain →

Hanya pemilik organisasi pada Paket Perusahaan yang dapat membuat dan melihat token API SCIM. Untuk membuat token API SCIM:

1. Buka pengalih ruang kerja dan pilih Kelola organisasi. Anda mungkin perlu Menyiapkan organisasi terlebih dahulu jika belum melakukannya. Pelajari lebih lanjut di sini →

2. Di tab Umum pada kontrol tingkat organisasi Anda, pilih > di samping Penyediaan SCIM.

Saat pemilik ruang kerja meninggalkan ruang kerja atau peran mereka diubah, token mereka akan dicabut. Saat ini terjadi, pesan otomatis akan dikirim ke pemilik ruang kerja lainnya untuk memberi tahu mereka agar mengganti token yang dicabut tersebut.

Selain itu, token aktif dapat dicabut oleh pemilik ruang kerja mana pun di ruang kerja tersebut. Untuk mencabut token, klik 🗑 di samping token terkait.

Jika token dicabut, Anda perlu menggantinya di integrasi mana pun yang ada.

Setiap integrasi SCIM dan penyediaan pengguna yang mengandalkan token yang dicabut akan dinonaktifkan hingga diganti dengan token aktif.

Untuk mengontrol apakah pengguna akan menerima undangan ke ruang kerja dan grup melalui email saat disediakan oleh SCIM, pemilik organisasi pada Paket Perusahaan dapat:

1. Buka pengalih ruang kerja Anda dan pilih Kelola organisasi.

2. Di tab Umum, Tombol Sembunyikan email undangan dari penyediaan SCIM jika Anda tidak ingin mengirim email kepada pengguna.

Untuk menyediakan anggota terbatas melalui SCIM, Anda harus mengatur atribut 'role' SCIM ke 'restricted_member':

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

Untuk mengubah tamu halaman menjadi anggota terbatas melalui SCIM, Anda harus menggunakan POST /scim/v2/Users.

• GET /ServiceProviderConfig

  • GET

  • Ambil deskripsi fitur spesifikasi SCIM yang tersedia.

  • Didefinisikan dalam Bagian 5 dari Spesifikasi Protokol SCIM.

• GET /ResourceTypes

  • GET

  • Ambil daftar tipe sumber daya SCIM yang tersedia.

  • Didefinisikan dalam Bagian 6 dari Spesifikasi Protokol SCIM.

Tabel di bawah ini menguraikan pemetaan antara atribut pengguna SCIM dan kolom profil pengguna Notion. Pemilik organisasi memilih atribut mana yang akan dikirim ke Notion dan dapat memperbarui atribut tersebut kapan saja. Notion memproses atribut yang Anda kirim melalui API SCIM Notion untuk meningkatkan pengalaman penyediaan dan pengelolaan pengguna serta grup.

• GET /Users

  • GET

  • Mengambil daftar anggota ruang kerja yang dipaginasi.

  • Anda dapat melakukan paginasi menggunakan parameter startIndex dan count. Perhatikan bahwa startIndex diindeks mulai dari 1 dan count memiliki nilai maksimum 100.

  • Anda dapat memfilter hasil dengan parameter filter. Atribut yang valid untuk memfilter adalah email, given_name, dan family_name, contohnya GET

  • Perhatikan bahwa given_name dan family_name bersifat peka huruf besar-kecil. Email dikonversi menjadi huruf kecil.

• GET /Users/

  • GET

  • Mengambil anggota ruang kerja tertentu berdasarkan ID pengguna Notion-nya. Ini akan berupa UUID dengan 32 karakter dalam format berikut: 00000000-0000-0000-0000-000000000000.

  • Perhatikan bahwa meta.created dan meta.lastModified tidak mencerminkan nilai stempel waktu yang bermakna.

• POST /Users

  • POST

  • Jika pengguna yang Anda tambahkan sudah memiliki akun pengguna Notion dengan email yang sama, maka mereka akan ditambahkan ke ruang kerja Anda.

  • Jika pengguna tidak ada, memanggil ini akan membuat pengguna Notion baru lalu menambahkan pengguna tersebut ke ruang kerja Anda. Mereka akan dipetakan ke profil pengguna Notion yang dibuat.

  • API SCIM akan membaca properti foto profil saat pembuatan pengguna, tetapi tidak pada pembaruan di masa mendatang.

• PATCH /Users/

  • PATCH

  • Memperbarui melalui serangkaian operasi, dan mengembalikan catatan pengguna yang diperbarui.

• PUT /Users/

  • PUT

  • Memperbarui, dan mengembalikan catatan pengguna yang diperbarui.

• DELETE /Users/

  • DELETE

  • Menghapus pengguna dari ruang kerja Anda. Pengguna tersebut akan dikeluarkan dari semua sesi aktif.

    • Akun pengguna tidak dapat dihapus melalui SCIM. Penghapusan akun harus dilakukan secara manual.

    • Menghapus pengguna dari ruang kerja Anda juga dapat dilakukan dengan menyetel atribut pengguna active ke false dengan mengirimkan permintaan PATCH /Users/ atau PUT /Users/.

    • Pemilik ruang kerja yang membuat token bot SCIM tidak dapat dihapus melalui API. Saat pemilik ruang kerja dihapus melalui API SCIM, token apa pun yang mereka buat akan dicabut dan integrasi apa pun yang menggunakan bot tersebut akan rusak.

• GET /Groups

  • GET

  • Ambil daftar grup ruang kerja yang dipaginasi.

  • Anda dapat melakukan paginasi menggunakan parameter startIndex dan count. Perhatikan bahwa startIndex menggunakan indeks 1 dan count memiliki nilai maksimum 100, contohnya GET

    • Jika paginasi tidak digunakan, maksimal 100 grup ruang kerja akan dikembalikan dalam satu permintaan.

  • Anda dapat memfilter hasil dengan parameter filter. Grup dapat difilter berdasarkan atribut displayName-nya, contohnya GET

• GET /Groups/

  • GET

  • Ambil grup ruang kerja tertentu berdasarkan ID grup Notion-nya. Ini akan berupa UUID dengan 32 karakter dalam format berikut: 00000000-0000-0000-0000-000000000000.

• POST /Groups

  • POST

  • Buat grup ruang kerja baru.

• PATCH /Groups/

  • PATCH

  • Perbarui grup ruang kerja melalui serangkaian operasi.

• PUT /Groups/

  • PUT

  • Perbarui grup ruang kerja.

• DELETE /Groups/

  • DELETE

  • Hapus grup ruang kerja.