Organization
Organization adalah wadah tingkat tertinggi yang menampung Space. Satu perusahaan atau tim setara dengan satu Organization, dan di bawahnya ditempatkan beberapa Space. Karena paket langganan (plan) dan keanggotaan dikelola pada tingkat Organization, penagihan dan hak akses anggota diterapkan berdasarkan Organization ini, bukan Space.
Daftar Organization yang Anda ikuti diperoleh melalui GET /me/organization-memberships. Resource ini tidak memiliki endpoint yang mengembalikan seluruh daftar.
Struktur resource
Berikut adalah respons pengambilan tunggal untuk Organization "Perusahaan DailyWear". Resource ini memiliki sys (properti sistem) serta properti isi name dan description.
{
"sys": {
"id": "ilLRJxDp",
"type": "Organization",
"createdBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"createdAt": "2026-05-11T10:51:16.832Z",
"updatedBy": { "sys": { "id": "3p4tcFbQRwz503VXdtHXNI5dZH5TVB", "type": "Refer", "targetType": "User" } },
"updatedAt": "2026-05-11T10:51:16.832Z",
"version": 1,
"isOfficial": false,
"plan": { "sys": { "id": "free", "type": "Refer", "targetType": "Plan" } }
},
"name": "Perusahaan DailyWear",
"description": "Perusahaan yang menjalankan toko online pakaian dan aksesori"
}Kunci utama:
name: nama Organization (1 hingga 64 karakter). Nama tampilan perusahaan atau tim.description: keterangan tentang Organization (1 hingga 128 karakter, opsional).plan:Refer<Plan>yang menunjuk paket langganan Organization ini (misalnyafree). Paket penagihan terikat di sini.isOfficial: apakah ini Organization resmi (boolean).
Properti sistem (sys) dan isi
Setiap Organization menyimpan properti sistem umum di dalam objek sys. createdBy dan updatedBy masuk dalam bentuk Refer ({ "sys": { "id", "type": "Refer", "targetType" } }), dan plan adalah Refer<Plan>.
| Properti | Tipe | Keterangan |
|---|---|---|
id | string | Pengenal unik resource. |
type | string | Jenis resource. Untuk Organization selalu "Organization". |
createdBy | Refer<User> | Pengguna yang membuat. |
createdAt | string (date-time) | Waktu pembuatan. |
updatedBy | Refer<User> | Pengguna yang terakhir mengubah. |
updatedAt | string (date-time) | Waktu perubahan terakhir. |
version | integer (≥1) | Versi resource. Naik 1 setiap kali diubah. |
isOfficial | boolean | Apakah Organization resmi. |
plan | Refer<Plan> | Paket langganan. Misalnya free. |
Properti isi:
| Properti | Tipe | Keterangan |
|---|---|---|
name | string (1~64) | Nama Organization. Ditentukan saat pembuatan dan perubahan. |
description | string (1~128) | Keterangan Organization. Bersifat opsional. |
icon | string (baca) / object (tulis) | Ikon Organization. Pada respons berupa string URL gambar. Pada permintaan perubahan dikirim sebagai objek yang menunjuk berkas yang telah diunggah { "upload": { "sys": { ..., "targetType": "Upload" } } } (referensi Upload yang diterima melalui Upload API). |
consoleHomeUrl | string (uri) | Halaman yang ditampilkan menggantikan layar beranda bawaan pada semua Space di bawah Organization ini. Tentukan URL https yang bukan alamat konsol (syarat). Bersifat opsional. |
Organization adalah resource pengaturan yang tidak memiliki konsep publikasi. Karena itu, berbeda dengan Content dan Media, sys-nya tidak memiliki publish, archive, atau status, dan hanya memiliki version. version naik setiap kali Organization diubah.
Perubahan (PUT) mengganti seluruh resource, dan arti dari nilai yang tidak dikirim justru berlawanan pada kedua properti opsional tersebut. Jika icon dihilangkan, ikon yang ada tetap dipertahankan, tetapi jika consoleHomeUrl dihilangkan, alamat yang tersimpan akan terhapus. Untuk mempertahankan alamat yang sudah ditentukan, Anda harus mengirimkan nilai tersebut setiap kali melakukan perubahan. Perubahan sebagian (PATCH) hanya menyentuh properti yang ditulis dalam patch, sehingga consoleHomeUrl dibiarkan apa adanya jika Anda tidak menyebutkannya.
Syarat halaman yang ditampilkan di layar beranda
Tersimpannya sebuah alamat tidak berarti halaman tersebut ikut ditampilkan. Meskipun Anda menentukan alamat yang menolak untuk ditampilkan, permintaan penyimpanan tetap berhasil dan tidak ada error yang dikembalikan; hal itu hanya terlihat sebagai tidak adanya apa pun yang muncul di layar beranda.
Agar dapat ditampilkan di tempat tersebut, halaman itu harus memenuhi hal berikut.
- Disajikan melalui HTTPS. Karena konsol berjalan di atas HTTPS, halaman yang tidak memakai koneksi aman akan diblokir tampilannya oleh browser.
- Mengizinkan tampilan di dalam halaman lain. Tetapkan
Content-Security-Policy: frame-ancestors https://console.weegloo.compada header respons. JikaX-Frame-Optionsmenghalangi tampilan tersebut, sesuaikan pengaturan itu juga. - Jika memakai cookie, terbitkan cookie dengan
SameSite=None; Secure. Karena ini adalah konteks yang ditampilkan di dalam situs lain, cookie tanpa penanda tersebut tidak akan dikirim.
Halaman ditampilkan di dalam <iframe>, dan pada frame tersebut hanya izin di bawah ini yang dibuka.
| Atribut | Yang menjadi mungkin bagi halaman |
|---|---|
sandbox="allow-scripts" | Menjalankan skrip. |
sandbox="allow-same-origin" | Membaca dan menulis cookie serta penyimpanan pada asalnya sendiri, dan mengirim permintaan ke servernya sendiri. |
sandbox="allow-forms" | Mengirim formulir. |
sandbox="allow-popups" | Membuka jendela baru atau tab baru. |
sandbox="allow-popups-to-escape-sandbox" | Membuat jendela yang dibuka dengan cara itu tidak mewarisi pembatasan ini. |
sandbox="allow-downloads" | Memulai pengunduhan berkas. |
sandbox="allow-storage-access-by-user-activation" | Meminta izin akses penyimpanan ketika pengguna melakukan interaksi. |
allow="fullscreen" | Beralih ke layar penuh. |
allow="clipboard-write" | Menulis ke papan klip. |
Apa pun yang tidak tercantum di sini tidak akan bekerja. Dalam keadaan itu tidak ada error yang muncul dan pemanggilannya diabaikan secara diam-diam, sehingga kode tidak dapat mengetahui apakah pemanggilan tersebut diblokir.
Pada frame tersebut juga ditetapkan referrerpolicy="strict-origin-when-cross-origin". Karena itu, yang diteruskan ke halaman hanya sampai asal (origin) konsol, sedangkan layar tempat halaman itu dibuka tidak ikut diteruskan.
Terlepas dari sandbox, halaman yang memerlukan login bisa saja tidak bekerja sebagaimana mestinya. Karena sebagian besar penyedia login memblokir login dari dalam halaman lain, login sosial umumnya tidak bekerja.
Error
Berikut adalah kode yang muncul saat Anda menangani Organization. Untuk kode yang berlaku umum pada semua resource, lihat Error umum.
| Kode | Kondisi |
|---|---|
WGL422078 | Anda mencoba menghapus Organization dengan paket langganan selain paket gratis. Anda harus menurunkan paket Organization tersebut ke paket gratis lebih dahulu. |
WGL422079 | Anda mencoba menghapus Organization dengan langganan yang belum dihentikan atau dengan perubahan langganan yang masih tertunda. |
WGL422024 | Anda mencoba menghapus Organization yang masih memiliki Space. Anda baru dapat menghapus Organization tersebut setelah semua Space dihapus. |
WGL422046 | Berkas yang Anda unggah sebagai icon melampaui ukuran yang diizinkan. |
WGL422047 | Berkas yang Anda unggah sebagai icon bukan PNG, JPG, atau WebP. |
WGL400072 | Format consoleHomeUrl tidak benar, atau alamat yang ditunjuk adalah alamat konsol. |
API
Base URL untuk semua endpoint di bawah ini adalah https://cma.weegloo.com/v1, dan header Authorization memerlukan Bearer token yang mengautentikasi ke CMA. Untuk perubahan dan perubahan sebagian, header X-Weegloo-Version (yaitu sys.version resource saat ini) harus disertakan demi kontrol konkurensi optimis. Pembuatan dan penghapusan tidak menggunakan header ini.
Dokumen terkait
- Space: Space di bawah Organization ini.
- Organization Membership: anggota Organization dan pengambilan organisasi yang Anda ikuti.
