Anggota

Anggota organisasi adalah pengguna yang memiliki akses ke organisasi Capgo Anda. Setiap anggota memiliki peran tertentu yang menentukan izin mereka dalam organisasi. Mengelola anggota dengan efektif sangat penting untuk menjaga keamanan dan kerja sama dalam tim Anda.

Peran Anggota

Peran Biasa

• baca: Dapat melihat sumber daya tetapi tidak dapat membuat perubahan
• unggah: Dapat mengunggah bundle baru dan melihat sumber daya
• upload : Dapat mengubah sumber daya dan mengunggah bundle
• admin : Dapat mengelola pengaturan organisasi dan anggota
• super_admin : Memiliki kendali penuh atas organisasi

Undang Peran

• invite_read : Undangan menunggu untuk akses baca
• invite_upload : Undangan menunggu untuk akses unggah
• invite_writeMenunggu undangan untuk akses tulis
• invite_adminMenunggu undangan untuk akses admin
• invite_super_adminMenunggu undangan untuk akses super admin

Praktik Terbaik

1. Pengaturan Peran: Ikuti prinsip keamanan terkecil ketika mengatur peran
2. Audit Teratur: Tinjau secara berkala akses anggota dan hapus akun yang tidak digunakan
3. Pengenalan Anggota: Proses yang jelas untuk menambahkan anggota baru dan menugaskan peran
4. Offboarding: Segera hapus akses untuk anggota yang meninggalkan organisasi

Endpoints

POST

https://api.capgo.app/organization/members/

Tambahkan anggota baru ke organisasi atau perbarui peran anggota yang sudah ada. Perlu diingat bahwa Anda hanya bisa mengundang pengguna yang sudah memiliki akun Capgo - email harus sesuai dengan pengguna Capgo yang sudah ada.

Request Body

interface MemberCreate {
  orgId: string
  email: string
  role: "read" | "upload" | "write" | "admin" | "super_admin"
}

Contoh Permintaan

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 Berhasil

{
  "status": "OK",
  "data": {
    "uid": "user_789",
    "email": "newmember@example.com",
    "role": "invite_write",
    "image_url": null
  }
}

Catatan:

• Ketika menambahkan anggota baru, mereka akan menerima surel undangan. Peran mereka akan ditambahkan dengan prefix “invite_” sampai mereka menerima undangan.
• Pengguna harus sudah memiliki akun Capgo sebelum mereka dapat diundang. Jika mereka tidak memiliki akun, mereka sebaiknya membuat akun terlebih dahulu di https://console.capgo.app/register/

GET

https://api.capgo.app/organization/members/

Ambil semua anggota organisasi.

Parameter Pencarian

interface MemberQuery {
  orgId: string
}

Tipe Respons

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 Permintaan

curl -H "authorization: your-api-key" \
  "https://api.capgo.app/organization/members/?orgId=org_123"

Contoh Respons

{
  "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"
    }
  ]
}

DELETE

https://api.capgo.app/organization/members/

Hapus anggota dari organisasi. Ini akan langsung membatalkan akses mereka.

Badan Permintaan

interface MemberDelete {
  orgId: string
  email: string
}

Contoh Permintaan

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/

Respon Berhasil

{
  "status": "OK"
}

Pengelolaan Kesalahan

Skenario Kesalahan Umum dan Responnya:

// Member not found
{
  "error": "Member not found",
  "status": "KO"
}

// Invalid role
{
  "error": "Invalid role specified",
  "status": "KO"
}

// Permission denied
{
  "error": "Insufficient permissions to manage members",
  "status": "KO"
}

// Cannot remove last admin
{
  "error": "Cannot remove the last admin from the organization",
  "status": "KO"
}

// Invalid email
{
  "error": "Invalid email format",
  "status": "KO"
}

// Member already exists
{
  "error": "Member already exists in organization",
  "status": "KO"
}

Penggunaan Umum

1. Ekspansi TimMenambahkan Anggota Tim dengan Peran yang Tepat
2. Kontrol Akses: Mengelola izin anggota saat tanggung jawab berubah
3. Security Audit: Mengulas daftar anggota dan peran secara berkala
4. Team Restructuring: Mengupdate peran selama perubahan organisasi

Keep going from Members

Jika Anda menggunakan Members untuk merencanakan keamanan dan keterpaduan, hubungkannya dengan Encryption untuk detail implementasi di Encryption, Kepatuhan untuk detail implementasi di Kepatuhan, Capgo Scanner Keamanan untuk alur kerja produk di Capgo Scanner Keamanan, Capgo Keamanan untuk alur kerja produk di Capgo Keamanan, dan Capgo Pusat Kepercayaan untuk alur kerja produk di Capgo Pusat Kepercayaan.