Langsung ke konten utama
Dalam operasional sehari-hari Knowledge Base organisasi, seiring berkembangnya kebutuhan kolaborasi tim, admin sering kali perlu menyesuaikan izin akses secara fleksibel—misalnya menambahkan karyawan baru ke Knowledge Base saat onboarding, menyesuaikan peran pengguna, atau mencabut akses setelah karyawan keluar. API manajemen anggota Knowledge Base memungkinkan Anda melakukan operasi ini secara terprogram dan mengotomatiskan pengelolaan izin Knowledge Base.

Kasus penggunaan

Pilih alur yang sesuai berdasarkan skenario berikut:
  • Skenario 1: Ketika karyawan baru onboarding, kolaborator eksternal bergabung, atau sebuah departemen/grup perlu mengakses Knowledge Base, admin dapat menggunakan alur ini untuk menambahkan anggota secara massal dan menetapkan peran.
  • Skenario 2: Ketika seorang anggota dipromosikan menjadi admin, atau Anda perlu membatasi operasi anggota, gunakan alur ini untuk mengubah perannya.
  • Skenario 3: Ketika seorang anggota keluar, sebuah proyek berakhir, atau Anda perlu mencabut akses untuk pengguna atau departemen tertentu, gunakan alur ini untuk menghapusnya dari Knowledge Base.
  • Skenario 4: Ketika organisasi ingin membuat sebuah Knowledge Base (seperti kebijakan perusahaan atau manual produk) dapat diakses oleh semua karyawan tanpa menambahkan anggota satu per satu.
  • Skenario 5: Digunakan ketika Anda perlu mengaudit izin Knowledge Base, memecahkan masalah izin, atau memastikan peran anggota saat ini sebelum melakukan operasi massal.

Ikhtisar izin

Peran izin (roleId)

Catatan: Peran OWNER tidak dapat ditambahkan atau dihapus melalui API. Pembuat Knowledge Base secara default menjadi pemiliknya.

Tipe anggota (members.type)


Skenario 1: Memberikan akses Knowledge Base kepada anggota baru

  1. Panggil API Dapatkan daftar Knowledge Base dan baca bidang rootNodeId dari respons. Ini adalah dentryUuid dari node root Knowledge Base.
  2. Dapatkan ID anggota:
  3. Panggil API Tambahkan izin dan pilih peran yang sesuai berdasarkan kebutuhan bisnis Anda (misalnya, EDITOR untuk pengeditan kolaboratif, READER untuk akses hanya baca) untuk menambahkan anggota ke Knowledge Base.
    Tips: Satu permintaan mendukung hingga 30 anggota. Bagi menjadi beberapa panggilan jika melebihi batas ini.

Skenario 2: Menyesuaikan peran anggota di Knowledge Base

  1. Untuk memastikan peran anggota saat ini, panggil terlebih dahulu API Dapatkan daftar izin.
  2. Panggil API Ubah izin dan tentukan anggota serta peran target untuk mengubah peran.
    Catatan: Seorang anggota hanya dapat memegang satu peran di Knowledge Base yang sama. Setelah perubahan, peran lama secara otomatis digantikan.

Skenario 3: Mencabut akses Knowledge Base seorang anggota

  1. Pastikan peran yang saat ini dipegang oleh anggota. Panggil API Dapatkan daftar izin untuk mengambil peran anggota saat ini (roleId). Peran yang ditentukan untuk penghapusan harus cocok dengan peran yang sebenarnya dipegang.
  2. Panggil API Hapus izin.
    Catatan: roleId harus cocok dengan peran yang sebenarnya dipegang oleh anggota; jika tidak, operasi menjadi tidak valid. Peran OWNER tidak dapat dihapus.

Skenario 4: Membuat Knowledge Base dapat diakses oleh semua karyawan

Panggil API Tambahkan izin, atur tipe anggota menjadi ORG, dan tentukan peran publik yang sesuai.
Catatan: Setelah otorisasi ORG, semua karyawan di organisasi dapat mengakses Knowledge Base dengan peran yang ditentukan. Anggota bertipe ORG tidak muncul dalam hasil kueri daftar anggota. Untuk mencabut akses bagi semua karyawan, panggil API penghapusan dengan cara yang sama dan berikan ORG sebagai type.

Skenario 5: Mengueri daftar anggota Knowledge Base saat ini

Panggil API Dapatkan daftar izin. Pemfilteran berdasarkan peran dan penomoran halaman didukung.
Setiap rekaman dalam respons berisi tipe, ID, nama, dan peran anggota. Jika nextToken tidak kosong, tersedia lebih banyak data. Berikan nextToken pada permintaan berikutnya untuk melanjutkan pengambilan hasil.

Catatan

  • Operator harus memiliki izin OWNER atau MANAGER pada Knowledge Base; jika tidak, API mengembalikan error izin tidak memadai.
  • Peran OWNER tidak dapat ditambahkan atau dihapus melalui API. Pembuat Knowledge Base secara default menjadi pemiliknya.
  • Saat menghapus anggota, roleId harus cocok dengan peran yang sebenarnya dipegang oleh anggota; jika tidak, operasi menjadi tidak valid.
  • Satu permintaan mendukung hingga 30 anggota dalam daftar members. Bagi menjadi beberapa panggilan jika melebihi batas ini.