Anggota

Anggota organisasi adalah pengguna yang memiliki akses ke organisasi Anda Capgo. 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
• Upload: Dapat mengunggah bundle baru dan melihat sumber daya
• Tulis: Dapat mengubah sumber daya dan mengunggah bundle
• Admin: Dapat mengelola pengaturan organisasi dan anggota
• Super Admin: Memiliki kontrol penuh atas organisasi

Peran Undangan

• invite_read: Menunggu undangan untuk akses baca
• invite_upload: Menunggu undangan untuk akses unggah
• invite_write: Menunggu undangan untuk akses tulis
• invite_admin: Menunggu undangan untuk akses admin
• invite_super_admin: Menunggu undangan untuk akses super admin

Praktik Terbaik

1. Pengaturan Peran: Ikuti prinsip keamanan terkecil ketika mengatur peran
2. Audit Reguler: Periksa secara berkala akses anggota dan hapus akun yang tidak digunakan
3. Pengenalan: Berikan proses yang jelas untuk menambahkan anggota baru dan mengatur peran
4. Offboarding: Hapus akses segera untuk anggota yang meninggalkan organisasi

Endpoint

: Kirim

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.

Badan Permintaan

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 Sukses

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

Catatan:

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

GET

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

Mengambil semua anggota organisasi.

Parameter Pemintaan

interface MemberQuery {
  orgId: string
}

Jenis Respon

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

Hapus

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

Hapus anggota dari sebuah organisasi. Ini akan langsung mengambil hak 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/

Respons Sukses

{
  "status": "OK"
}

Pengelolaan Kesalahan

Skenario kesalahan umum dan responsnya:

// 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 Tim: Menambahkan anggota tim dengan peran yang tepat
2. Pengendalian Akses: Mengelola izin anggota sesuai dengan perubahan tanggung jawab
3. Uji Audit Keamanan: Mengulas daftar anggota dan peran secara berkala
4. Merestructur Tim: Mengupdate peran selama perubahan organisasi

Teruskan dari Anggota

Jika Anda menggunakan Anggota Anggota untuk merencanakan keamanan dan keterpaduan, hubungkannya dengan Enkripsi untuk detail implementasi di Enkripsi, Keterpaduan Capgo Security Scanner Capgo Scanner Keamanan untuk alur kerja produk di Capgo Scanner Keamanan, Capgo Keamanan Capgo Pusat Kepercayaan untuk alur kerja produk di Capgo Pusat Kepercayaan.