Anggota

Organization members are users who have access to your Capgo organization. Each member has a specific role that determines their permissions within the organization. Managing members effectively is crucial for maintaining security and collaboration in your team.

Peran Anggota

Bab berjudul “Peran Anggota”

• readDapat melihat sumber daya tetapi tidak dapat membuat perubahan
• unggahMembaca dapat mengunggah bundle baru dan melihat sumber daya
• tuliskanMembaca dapat memodifikasi sumber daya dan mengunggah bundle
• adminMembaca dapat mengelola pengaturan organisasi dan anggota
• admin superMembaca memiliki kontrol penuh atas organisasi

Undang Peran

• undang_bacaMenunggu undangan untuk akses baca
• Unduh UndanganMenunggu undangan untuk akses unggah
• Undang MenulisMenunggu undangan untuk akses tulis
• Undang AdminMenunggu undangan untuk akses admin
• Undang Admin UtamaMenunggu undangan untuk akses super admin

Praktik Terbaik

1. Pengaturan Peran: Ikuti prinsip keamanan terendah ketika menugaskan peran
2. Audits Reguler: Periksa secara berkala akses anggota dan hapus akun yang tidak digunakan
3. Onboarding: Miliki proses yang jelas untuk menambahkan anggota baru dan menugaskan peran
4. Offboarding: Hapus akses untuk anggota yang meninggalkan organisasi secara cepat

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 dapat 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 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 email 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 harus membuatnya terlebih dahulu di https://console.capgo.app/register/

GET

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

Mengambil semua anggota organisasi.

Parameter Kueri

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 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/

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 baru dengan peran yang tepat
2. Kontrol Akses: Mengelola izin anggota sesuai dengan perubahan tanggung jawab
3. Audit Keamanan: Mereview daftar anggota dan peran secara berkala
4. Restrukturisasi Tim: Mengupdate peran selama perubahan organisasi

Lanjutkan dari Anggota

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