Referensi API lengkap untuk mengelola pengguna, undangan, peran, dan izin dalam proyek dan perusahaan Blue
Ikhtisar
API Manajemen Pengguna menyediakan alat yang komprehensif untuk mengelola anggota tim, mengontrol izin akses, dan mengorganisir tenaga kerja Anda di seluruh proyek dan perusahaan Blue. Apakah Anda menambahkan anggota tim baru, mengelola pengguna yang ada, atau mendefinisikan struktur izin kustom, API ini menangani semua aspek manajemen siklus hidup pengguna.
Manajemen pengguna di Blue beroperasi pada dua tingkat:
- Tingkat Proyek: Mengelola pengguna dalam proyek tertentu dengan izin khusus proyek
- Tingkat Perusahaan: Mengelola pengguna di seluruh organisasi Anda dengan akses di tingkat perusahaan
Operasi yang Tersedia
Manajemen Pengguna Inti
Operasi | Deskripsi | Tautan |
---|---|---|
Invite User | Kirim undangan kepada pengguna baru dengan tingkat akses tertentu | View Details → |
List Users | Kuery dan filter pengguna dalam proyek atau perusahaan | View Details → |
Remove User | Hapus pengguna dari proyek atau perusahaan | View Details → |
Manajemen Peran dan Izin
Operasi | Deskripsi | Tautan |
---|---|---|
Custom Roles | Buat dan kelola peran kustom dengan izin yang terperinci | View Details → |
Tingkat Akses
Blue menyediakan sistem izin hierarkis dengan tingkat akses yang telah ditentukan sebelumnya:
Tingkat Akses Standar
Tingkat | Deskripsi | Kemampuan |
---|---|---|
OWNER | Kontrol penuh atas proyek/perusahaan | All permissions, can transfer ownership |
ADMIN | Akses administratif | User management, settings, billing |
MEMBER | Anggota tim standar | Full project functionality, limited admin access |
CLIENT | Akses klien eksternal | Limited project visibility, focused on deliverables |
COMMENT_ONLY | Akses hanya komentar | Dapat melihat dan mengomentari, tidak dapat mengedit |
VIEW_ONLY | Akses hanya baca | Can view content only |
Hierarki Izin
Pengguna hanya dapat mengundang atau mengelola pengguna di tingkat mereka atau di bawahnya:
- PEMILIK dapat mengelola semua tingkat akses
- ADMIN dapat mengelola ADMIN, ANGGOTA, KLIEN, KOMENTAR_HANYA, LIHAT_HANYA
- ANGGOTA dapat mengelola ANGGOTA, KLIEN, KOMENTAR_HANYA, LIHAT_HANYA
- KLIEN hanya dapat mengelola KLIEN lainnya
Konsep Kunci
Undangan Pengguna
- Berdasarkan email: Pengguna diundang melalui alamat email
- Penugasan peran: Atur tingkat akses dan peran kustom opsional selama undangan
- Multi-proyek: Satu undangan dapat memberikan akses ke beberapa proyek
- Kedaluwarsa: Undangan kedaluwarsa setelah 7 hari
- Notifikasi otomatis: Blue mengirim undangan email secara otomatis
Akses Proyek vs Perusahaan
- Undangan proyek: Memberikan akses hanya ke proyek tertentu
- Undangan perusahaan: Memberikan akses di tingkat perusahaan, opsional termasuk proyek tertentu
- Pemilik perusahaan: Secara otomatis mendapatkan akses ADMIN ke semua proyek perusahaan
- Pembatasan cakupan: Tidak dapat menggabungkan parameter undangan proyek dan perusahaan
Peran Kustom
- Izin terperinci: Mendefinisikan kemampuan spesifik di luar tingkat akses standar
- Spesifik proyek: Peran kustom dibatasi pada proyek individu
- Kontrol tingkat bidang: Mengontrol akses ke bidang kustom tertentu
- Pembatasan tindakan: Membatasi tindakan tertentu (buat, edit, hapus, dll.)
Pola Umum
Mengundang Anggota Tim Baru
mutation InviteTeamMember {
inviteUser(input: {
email: "john.doe@company.com"
projectId: "web-redesign"
accessLevel: MEMBER
})
}
Membuat Undangan Seluruh Perusahaan
mutation InviteToCompany {
inviteUser(input: {
email: "manager@company.com"
companyId: "company_123"
projectIds: ["project_1", "project_2", "project_3"]
accessLevel: ADMIN
})
}
Mendaftar Pengguna Proyek
query ProjectUsers {
projectUsers(projectId: "web-redesign") {
id
user {
name
email
avatar
}
accessLevel
role {
name
permissions
}
invitedAt
joinedAt
}
}
Menghapus Pengguna
mutation RemoveProjectUser {
removeUser(input: {
userId: "user_456"
projectId: "web-redesign"
})
}
Membuat Peran Kustom
mutation CreateCustomRole {
createProjectUserRole(input: {
projectId: "web-redesign"
name: "Content Reviewer"
permissions: {
canCreateRecords: false
canEditOwnRecords: true
canEditAllRecords: false
canDeleteRecords: false
canManageUsers: false
canViewReports: true
}
}) {
id
name
permissions
}
}
Manajemen Izin
Matriks Izin Standar
Tindakan | PEMILIK | ADMIN | ANGGOTA | KLIEN | KOMENTAR_HANYA | LIHAT_HANYA |
---|---|---|---|---|---|---|
Invite Users | ✅ Semua tingkat | ✅ ADMIN dan di bawah | ✅ ANGGOTA dan di bawah | ✅ KLIEN saja | ❌ Tidak | ❌ Tidak |
Remove Users | ✅ Semua pengguna | ✅ ADMIN dan di bawah | ✅ ANGGOTA dan di bawah | ✅ KLIEN saja | ❌ Tidak | ❌ Tidak |
Modify Project Settings | ✅ Ya | ✅ Ya | ❌ Tidak | ❌ Tidak | ❌ Tidak | ❌ Tidak |
Create Records | ✅ Ya | ✅ Ya | ✅ Ya | ✅ Terbatas | ❌ Tidak | ❌ Tidak |
Edit All Records | ✅ Ya | ✅ Ya | ✅ Ya | ❌ Tidak | ❌ Tidak | ❌ Tidak |
Delete Records | ✅ Ya | ✅ Ya | ✅ Ya | ❌ Tidak | ❌ Tidak | ❌ Tidak |
View Reports | ✅ Ya | ✅ Ya | ✅ Ya | ✅ Terbatas | ❌ Tidak | ❌ Tidak |
Kemampuan Peran Kustom
- Izin tingkat bidang: Mengontrol akses ke bidang kustom tertentu
- Aturan spesifik tindakan: Mengizinkan/melarang operasi tertentu (buat, edit, hapus)
- Pembatasan tampilan: Membatasi catatan mana yang dapat dilihat pengguna
- Pengalihan fitur: Mengaktifkan/mematikan fitur tertentu per peran
Praktik Terbaik
Onboarding Pengguna
- Mulai dengan peran standar - Gunakan tingkat akses yang telah ditentukan untuk sebagian besar pengguna
- Izin progresif - Mulai dengan akses terbatas, perluas sesuai kebutuhan
- Komunikasi yang jelas - Sertakan konteks saat mengirim undangan
- Tinjauan berkala - Audit akses pengguna secara berkala
Pertimbangan Keamanan
- Prinsip hak akses minimum - Berikan izin minimum yang diperlukan
- Audit akses berkala - Tinjau izin pengguna setiap kuartal
- Proses offboarding - Hapus akses segera ketika pengguna keluar
- Dokumentasi peran kustom - Dokumentasikan tujuan dan batasan peran kustom
Organisasi Tim
- Penamaan yang konsisten - Gunakan nama peran yang jelas dan deskriptif
- Konsolidasi peran - Hindari membuat terlalu banyak peran kustom yang serupa
- Struktur perusahaan - Sesuaikan izin dengan hierarki organisasi
- Pewarisan proyek - Pertimbangkan bagaimana peran perusahaan mempengaruhi akses proyek
Penanganan Kesalahan
Kesalahan umum saat mengelola pengguna:
Kode Kesalahan | Deskripsi | Solusi |
---|---|---|
USER_ALREADY_IN_THE_PROJECT |
Pengguna sudah memiliki akses proyek | Check current user list before inviting |
UNAUTHORIZED |
Izin tidak mencukupi untuk melakukan tindakan | Verify your access level and permissions |
PROJECT_NOT_FOUND |
Proyek tidak ada atau tidak ada akses | Confirm project ID and access rights |
INVITATION_LIMIT |
Mencapai batas undangan untuk tingkat penagihan | Upgrade plan or remove inactive users |
ADD_SELF |
Tidak dapat mengundang diri sendiri | Gunakan email yang berbeda atau minta admin lain untuk mengundang Anda |
COMPANY_BANNED |
Akun perusahaan ditangguhkan | Contact support to resolve account status |
Batas Laju
Operasi manajemen pengguna memiliki batas laju sebagai berikut:
- Undangan: 100 per jam per perusahaan
- Kuery pengguna: 1000 per jam per pengguna
- Modifikasi peran: 50 per jam per proyek
Sumber Daya Terkait
- API Proyek - Mengelola proyek yang berisi pengguna
- API Catatan - Memahami bagaimana izin pengguna mempengaruhi akses catatan
- API Automasi - Mengotomatiskan alur kerja manajemen pengguna
- API Bidang Kustom - Mengelola izin tingkat bidang untuk peran kustom