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

Peran Biasa

• baca: Dapat melihat sumber daya, tetapi tidak dapat membuat perubahan
• unggah: Dapat mengunggah bundle baru dan melihat sumber daya
• tulis: Dapat memodifikasi sumber daya dan mengunggah bundle
• admin: Dapat mengelola pengaturan organisasi dan anggota
• super_admin: Memiliki kontrol penuh atas organisasi

Undang Peran

• invite_read: Undangan menunggu akses baca
• invite_upload: Undangan menunggu akses unggah
• invite_write: Undangan menunggu akses tulis
• invite_admin: Undangan menunggu akses admin
• invite_super_adminTunggu undangan untuk akses admin super

Praktik Terbaik

1. Pengaturan PeranIkuti prinsip keamanan terkecil ketika mengatur peran
2. Auditor RegulerLakukan peninjauan periodik akses anggota dan hapus akun yang tidak digunakan
3. Pengenalan AnggotaMiliki proses yang jelas untuk menambahkan anggota baru dan mengatur peran
4. Penghentian AnggotaHapus akses segera untuk anggota yang meninggalkan organisasi

Endpoint

POST

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

Menambahkan anggota baru ke organisasi atau memperbarui peran anggota yang sudah ada. Perlu diingat bahwa Anda hanya dapat mengundang pengguna yang sudah memiliki akun Capgo - alamat email harus sesuai dengan pengguna Capgo yang sudah ada.

Tubuh 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 email undangan. Peran mereka akan diberi prefiks “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 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 Respon

{
  "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 sebuah organisasi. Hal 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 Berhasil

{
  "status": "OK"
}

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

Teruskan dari Anggota

Jika Anda menggunakan Anggota untuk merencanakan keamanan dan kewenangan, hubungkannya dengan Enkripsi untuk detail implementasi di Enkripsi, Kewenangan untuk detail implementasi di Kewenangan, 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.