Anggota

Member organisasi adalah pengguna yang memiliki akses ke organisasi Capgo Anda. Setiap member memiliki role spesifik yang menentukan izin mereka di dalam organisasi. Mengelola member secara efektif sangat penting untuk menjaga keamanan dan kolaborasi tim Anda.

Role Member

Peran Reguler

• baca: Bisa melihat resource tapi tidak bisa melakukan perubahan
• upload: Bisa upload bundle baru dan melihat resource
• write: Bisa modifikasi resource dan upload bundle
• admin: Bisa kelola pengaturan organisasi dan member
• super_admin: Punya kontrol penuh atas organisasi

Role Undangan

• membaca_undangan: Undangan tertunda untuk akses read
• unduh_undangan: Undangan tertunda untuk akses upload
• invite_write: Undangan akses tulis sedang diproses
• undang_admin: Undangan akses admin sedang diproses
• undang_super_admin: Undangan akses super admin sedang diproses

Praktik Terbaik

1. Penetapan Role: Gunakan prinsip least privilege saat menetapkan role
2. Audit Rutin: Tinjau akses member secara berkala dan hapus akun yang tidak terpakai
3. Onboarding: Miliki proses yang jelas untuk menambah anggota baru dan menetapkan role
4. Offboarding: Segera cabut akses bagi anggota yang keluar dari organisasi

Endpoint

POST

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

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

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

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

GET

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

Ambil semua anggota dari sebuah organisasi.

Parameter Query

interface MemberQuery {
  orgId: string
}

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

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

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

HAPUS

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

Hapus anggota dari organisasi. Tindakan ini akan segera mencabut akses mereka.

Body Request

interface MemberDelete {
  orgId: string
  email: string
}

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

{
  "status": "OK"
}

Penanganan error

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

1. Ekspansi Tim: Menambah anggota tim baru dengan role yang sesuai
2. Kontrol Akses: Mengelola permission anggota saat tanggung jawab berubah
3. Audit Keamanan: Meninjau daftar anggota dan role secara berkala
4. Restrukturisasi Tim: Memperbarui role selama perubahan organisasi

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.