Anggota
Salin prompt setup yang berisi langkah install dan panduan markdown lengkap untuk plugin ini.
Anggota organisasi adalah pengguna yang memiliki akses ke organisasi Capgo Anda. Setiap anggota memiliki peran spesifik yang menentukan izin mereka di dalam organisasi. Mengelola anggota secara efektif sangat penting untuk menjaga keamanan dan kolaborasi dalam tim Anda.
Role Member
Bagian berjudul “Peran Anggota”Peran Reguler
Bagian berjudul “Peran Reguler”- baca: Dapat melihat sumber daya tetapi tidak dapat membuat perubahan
- upload: Dapat meng-upload bundle baru dan melihat sumber daya
- write: Bisa modifikasi resource dan upload bundle
- admin: Bisa kelola pengaturan organisasi dan member
- super_admin: Punya kontrol penuh atas organisasi
Role Undangan
Bagian berjudul “Role Undangan”- membaca_undangan: Undangan tertunda untuk akses read
- unduh_undangan: Undangan tertunda untuk akses upload
- invite_write: Undangan tertunda untuk akses tulis
- Undang admin: Undangan tertunda untuk akses admin
- Undang super admin: Undangan tertunda untuk akses super admin
Praktik Terbaik
Bagian berjudul “Praktik Terbaik”- Penugasan Peran: Terapkan prinsip privilese minimum saat menugaskan peran
- Audit Rutin: Tinjau akses anggota secara berkala dan hapus akun yang tidak digunakan
- Onboarding: Miliki proses yang jelas untuk menambah anggota baru dan menetapkan role
- Offboarding: Segera cabut akses bagi anggota yang keluar dari organisasi
Endpoint
Bagian berjudul “Endpoints”https://api.capgo.app/organization/members/
Tambah anggota baru ke organisasi atau perbarui role anggota yang sudah ada. Perlu dicatat bahwa Anda hanya bisa mengundang pengguna yang sudah memiliki akun Capgo - email harus cocok dengan pengguna Capgo yang sudah ada.
Body Request
Bagian berjudul “Request Body”interface MemberCreate { orgId: string email: string role: "read" | "upload" | "write" | "admin" | "super_admin"}Contoh Request
Bagian berjudul “Contoh Request”curl -X POST \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "orgId": "org_123", "email": "newmember@example.com", "role": "write" }' \ https://api.capgo.app/organization/members/Respons Sukses
Bagian berjudul “Respons Sukses”{ "status": "OK", "data": { "uid": "user_789", "email": "newmember@example.com", "role": "invite_write", "image_url": null }}Catatan:
- Saat menambahkan anggota baru, mereka akan menerima email undangan. Peran mereka akan diawali dengan “invite_” sampai mereka menerima undangan tersebut.
- Pengguna harus sudah punya akun Capgo sebelum bisa diundang. Kalau belum punya akun, buat dulu di https://capgo.app/register/
https://api.capgo.app/organization/members/
Ambil semua anggota organisasi.
Parameter Query
Bagian berjudul “Parameter Query”interface MemberQuery { orgId: string}Tipe Response
Bagian berjudul “Tipe Response”interface Member { uid: string; email: string; image_url: string; role: "invite_read" | "invite_upload" | "invite_write" | "invite_admin" | "invite_super_admin" | "read" | "upload" | "write" | "admin" | "super_admin";}Contoh Request
Bagian berjudul “Contoh Request”curl -H "authorization: your-api-key" \ "https://api.capgo.app/organization/members/?orgId=org_123"Contoh Response
Bagian berjudul “Contoh Response”{ "data": [ { "uid": "user_123", "email": "john@example.com", "image_url": "https://example.com/avatar.png", "role": "admin" }, { "uid": "user_456", "email": "jane@example.com", "image_url": "https://example.com/avatar2.png", "role": "write" }, { "uid": "user_789", "email": "bob@example.com", "image_url": null, "role": "invite_read" } ]}https://api.capgo.app/organization/members/
Hapus anggota dari organisasi. Akses mereka akan dicabut segera.
Body Request
Bagian berjudul “Request Body”interface MemberDelete { orgId: string email: string}Contoh Request
Bagian berjudul “Contoh Request”curl -X DELETE \ -H "authorization: your-api-key" \ -H "Content-Type: application/json" \ -d '{ "orgId": "org_123", "email": "user@example.com" }' \ https://api.capgo.app/organization/members/Respons Sukses
Bagian berjudul “Respons Sukses”{ "status": "OK"}Penanganan error
Bagian berjudul “Error Handling”Semua error menggunakan format error standar yang dijelaskan di Ikhtisar API.
Skenario error umum dan responsnya:
// The API key has no access to the organization{ "error": "cannot_access_organization", "message": "You can't access this organization", "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }}
// Unknown role on update{ "error": "invalid_role", "message": "Invalid role", "moreInfo": { "role": "owner" }}
// Changing the role of the user who owns the API key{ "error": "cannot_change_own_role", "message": "You cannot change your own role", "moreInfo": {}}
// Removing a user who is not a member (HTTP 404){ "error": "organization_member_not_found", "message": "User is not a member of this organization", "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8", "email": "user@example.com" }}
// Removing the last super admin{ "error": "CANNOT_REMOVE_LAST_SUPER_ADMIN", "message": "Cannot remove the last super admin from the organization", "moreInfo": { "orgId": "046a36ac-e03c-4590-9257-bd6c9dba9ee8" }}Kasus Penggunaan Umum
Bagian berjudul “Kasus Penggunaan Umum”- Ekspansi Tim: Menambah anggota tim baru dengan role yang sesuai
- Kontrol Akses: Mengelola permission anggota saat tanggung jawab berubah
- Audit Keamanan: Meninjau daftar anggota dan role secara berkala
- Restrukturisasi Tim: Memperbarui role selama perubahan organisasi
Lanjutkan dari Members
Bagian berjudul “Lanjutkan dari Members”Jika Anda menggunakan Anggota untuk merencanakan keamanan dan kepatuhan, hubungkan dengan Enkripsi untuk detail implementasi pada Encryption, Kepatuhan untuk detail implementasi pada Compliance, Capgo Pemindai Keamanan untuk alur kerja produk di Capgo Security Scanner, Keamanan Capgo untuk alur kerja produk di Capgo Security, dan Capgo Pusat Kepercayaan untuk workflow produk di Capgo Trust Center.