Membuat dan mengelola Ruang Apigee

Halaman ini berlaku untuk Apigee dan Apigee hybrid.

Lihat dokumentasi Apigee Edge.

Halaman ini menjelaskan cara membuat Ruang Apigee di organisasi Apigee Anda untuk mengelola kebijakan Identity and Access Management (IAM) untuk resource Apigee API dalam skala besar.

Panduan ini menguraikan langkah-langkah yang diperlukan untuk:

• Membuat Ruang
• Mengelola anggota dan peran dalam Ruang
• Mencantumkan semua ruang dalam organisasi
• Mendapatkan detail Ruang
• Memperbarui Ruang
• Menghapus Ruang

Untuk mengetahui informasi selengkapnya tentang manfaat penggunaan Ruang Apigee untuk mengelola resource API, lihat Ruang Apigee.

Sebelum memulai

Sebelum mulai menggunakan Ruang:

• Sediakan Apigee. Konfirmasi bahwa organisasi Berlangganan Apigee atau Bayar sesuai penggunaan yang ingin Anda gunakan telah disediakan. Untuk mengetahui informasi selengkapnya tentang langkah-langkah yang diperlukan untuk menyediakan Apigee, lihat Pengantar penyediaan.
• Dapatkan kredensial autentikasi Anda. Sebelum menjalankan perintah untuk membuat dan mengelola Ruang di command line, dapatkan kredensial autentikasi gcloud menggunakan perintah berikut:

  export TOKEN=$(gcloud auth print-access-token)

Peran dan izin yang diperlukan

Pastikan Anda memiliki peran berikut di project: Apigee > Apigee Organization Admin

Memeriksa peran

1. Di konsol Google Cloud , buka halaman IAM.

   Buka IAM
2. Pilih project.

3. Di kolom Akun utama, temukan semua baris yang mengidentifikasi Anda atau grup yang Anda ikuti. Untuk mengetahui grup mana saja yang Anda ikuti, hubungi administrator Anda.

4. Untuk semua baris yang menentukan atau menyertakan Anda, periksa kolom Peran untuk melihat apakah daftar peran menyertakan peran yang diperlukan.

Memberikan peran

1. Di konsol Google Cloud , buka halaman IAM.

   Buka IAM
2. Pilih project.
3. Klik Grant access.

4. Di kolom New principals, masukkan ID pengguna Anda. Biasanya, ini adalah alamat email untuk Akun Google.

5. Klik Pilih peran, lalu telusuri peran.
6. Untuk memberikan peran tambahan, klik Add another role, lalu tambahkan tiap peran tambahan.
7. Klik Simpan.

Membuat Ruang

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.create. Izin ini disertakan dalam peran Apigee Organization Admin.

Buat Ruang di organisasi Apigee Anda menggunakan konsol Apigee atau API, seperti yang dijelaskan di bagian berikut.

Konsol Apigee

Untuk membuat Ruang menggunakan UI Apigee:

1. Di UI Apigee di Konsol Cloud, buka halaman Ruang.
   Buka Ruang
2. Klik Create. Panel Add Space Details akan terbuka.
3. Di kolom Name, masukkan ID unik untuk Ruang. Nama harus kurang dari 63 karakter, diawali dengan huruf kecil, dan hanya berisi karakter huruf kecil. Untuk persyaratan penamaan lengkap, lihat AIP-122: Nama resource.
4. (Opsional) Di kolom Nama Tampilan, masukkan label yang mudah dibaca untuk Ruang.
5. Klik Tambahkan.

Setelah dibuat, anggota organisasi akan melihat Ruang sebagai parameter yang tersedia saat membuat resource API.

Apigee API

Untuk membuat Ruang di organisasi Apigee Anda, gunakan perintah berikut:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces" \
    --data-raw '{
       "name":"SPACE_NAME",
       "displayName":"DISPLAY_NAME"
    }'

Dengan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• SPACE_NAME adalah nama dan ID unik Ruang. Nama harus kurang dari 63 karakter, diawali dengan huruf kecil, dan hanya berisi karakter huruf kecil. Untuk persyaratan penamaan lengkap, lihat AIP-122: Nama resource.
• DISPLAY_NAME adalah nama Ruang yang mudah dibaca seperti yang muncul di UI Apigee di Konsol Cloud.

Mengelola anggota dan peran dalam Ruang

Setelah membuat Ruang, Anda dapat menambahkan anggota tim ke Ruang dan menetapkan peran IAM yang diperlukan untuk membuat dan mengelola resource API.

Menambahkan anggota organisasi ke Ruang

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.setIamPolicy.

Catatan: Peran IAM apigee.spaceContentEditor berisi banyak izin yang diperlukan untuk mengelola resource Ruang. Sebaiknya Anda memberikan peran ini, setidaknya, kepada pengguna Ruang. Namun, Anda mungkin perlu memberikan peran tambahan kepada pengguna untuk melakukan tugas tertentu. Untuk mengetahui informasi selengkapnya, lihat Hierarki izin IAM di Ruang.

Konsol Apigee

Untuk memberikan akses anggota ke Ruang menggunakan UI Apigee:

1. Di UI Apigee di Konsol Cloud, buka halaman Ruang.
2. Klik nama Ruang yang ingin Anda kelola.
3. Di bagian Detail akses, klik Beri akses.
4. Di kolom Tambahkan anggota, masukkan alamat email pengguna atau grup yang ingin Anda tambahkan.
5. Di bagian Tetapkan peran, pilih Editor Konten atau Pelihat Konten.
6. Klik Tambahkan.

Catatan: Jika Anda memiliki izin resourcemanager.projects.setIamPolicy, sistem akan secara otomatis memberikan peran Apigee Space Console User kepada setiap anggota baru di tingkat project, sehingga mereka dapat mengakses UI Apigee di Konsol Cloud. Jika Anda tidak memiliki izin ini, Anda akan melihat peringatan, dan administrator project harus memberikan peran ini kepada pengguna secara manual.

Apigee API

Untuk menambahkan anggota organisasi ke Ruang dan menetapkan peran IAM, gunakan perintah berikut:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME:setIamPolicy" -d \
      '{
        "policy":{
          "bindings":[
            {
              "members": ["user:USER_EMAIL"],
              "role": "roles/IAM_ROLE"
            }
          ]
        }
      }'

Dengan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• SPACE_NAME adalah nama Ruang.
• USER_EMAIL adalah alamat email pengguna yang Anda tambahkan ke Ruang. Untuk menambahkan Grup Google, bukan satu pengguna, ubah awalan dari user: menjadi group: dan berikan alamat email grup.
• IAM_ROLE adalah nama peran IAM yang Anda tetapkan kepada anggota.

Menghapus anggota dari Ruang

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.setIamPolicy.

Konsol Apigee

Untuk menghapus anggota dari Ruang menggunakan UI Apigee:

1. Di UI Apigee di Konsol Cloud, buka halaman Spaces dan klik nama Ruang.
2. Di tabel Detail akses, centang kotak di samping satu atau beberapa anggota yang ingin Anda hapus.
3. Klik Hapus akses.
4. Pada dialog konfirmasi, klik Confirm.

Apigee API

Untuk menghapus anggota dari Ruang, tetapkan kebijakan IAM baru untuk ruang dengan daftar anggota yang direvisi menggunakan metode setIamPolicy. Menggunakan metode ini akan membuat kebijakan IAM baru yang menggantikan kebijakan yang ada.

Misalnya, untuk memperbarui anggota Ruang tim biru, Anda dapat memeriksa kebijakan IAM saat ini terlebih dahulu menggunakan perintah berikut:

curl -X GET -H "Authorization: Bearer $TOKEN" \
  "https://apigee.googleapis.com/v1/organizations/acme/spaces/blue:getIamPolicy"

Output perintah menampilkan kebijakan IAM saat ini untuk ruang, dan akan terlihat seperti ini:

{
  "version": "0",
  "bindings": [
    {
      "role": "roles/apigee.spaceContentEditor",
      "members": [
        "group:[e-mail]",
        "user:[e-mail]",
        "user:[e-mail]",
        "user:[e-mail]"
      ]
    }
  ]
}

Untuk menghapus [e-mail] dari Ruang, gunakan perintah berikut:

curl -X POST -H "Authorization: Bearer $TOKEN" -H "Content-type: application/json" \
  "https://apigee.googleapis.com/v1/organizations/acme/spaces/blue:setIamPolicy" -d \
    '{
      "policy":{
        "bindings":[
          {
            "members": [
              "group:[e-mail]",
              "user:[e-mail]",
              "user:[e-mail]"
            ],
            "role": "roles/apigee.spaceContentEditor"
          }
        ]
      }
    }'

Kebijakan IAM baru untuk Ruang tidak akan lagi menyertakan [e-mail].

Untuk menghapus anggota dari grup yang disertakan dalam Ruang, hapus anggota dari grup terlebih dahulu, lalu jalankan kembali perintah setIamPolicy untuk memperbarui kebijakan IAM untuk Ruang dengan keanggotaan yang benar untuk alias email grup.

Mencantumkan semua Ruang di organisasi

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.list.

Konsol Apigee

Untuk melihat semua Ruang, buka halaman Ruang di UI Apigee di Konsol Cloud.

Buka Ruang

Tabel Ruang mencantumkan semua Ruang di organisasi Anda, termasuk Nama, Nama Tampilan, dan jumlah total Anggota.

Apigee API

Untuk mencantumkan semua Ruang di organisasi Apigee, gunakan perintah berikut:

curl -X GET -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces"

Dengan:

• ORG_NAME adalah nama organisasi Apigee Anda.

Mendapatkan detail Ruang

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.get.

Konsol Apigee

Untuk melihat detail Ruang di UI Apigee:

1. Di UI Apigee di Konsol Cloud, buka halaman Ruang.
2. Klik nama Ruang yang ingin Anda lihat. Halaman detail menampilkan Nama, Nama Tampilan, detail akses, dan daftar Anggota.

Apigee API

Untuk mendapatkan detail Ruang, gunakan perintah berikut:

curl -X GET -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME"

Dengan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• SPACE_NAME adalah nama Ruang.

Memperbarui Ruang

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.update.

Anda dapat mengubah Nama Tampilan Ruang yang ada. Nama unik tidak dapat diubah setelah dibuat.

Konsol Apigee

Untuk memperbarui Ruang di UI Apigee:

1. Di UI Apigee di Konsol Cloud, buka halaman Ruang dan klik nama Ruang yang ingin Anda perbarui.
2. Klik tombol edit (ikon pensil) di samping judul "Detail ruang".
3. Ubah Nama Tampilan sesuai kebutuhan.
4. Klik Simpan.

Apigee API

Untuk memperbarui Ruang menggunakan API, gunakan perintah berikut:

curl -X PATCH -H "Authorization: Bearer $TOKEN" -H "Content-Type: application/json" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME" \
      --data-raw '{
        "displayName":"DISPLAY_NAME"
      }'

Dengan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• SPACE_NAME adalah nama Ruang.
• DISPLAY_NAME adalah nama tampilan baru untuk Ruang.

Menghapus Ruang

Untuk melakukan tugas ini, Anda memerlukan izin apigee.spaces.delete.

Konsol Apigee

Peringatan: Menghapus Ruang akan segera menghapus akses anggota Ruang ke Proxy API, Alur bersama, dan Produk API yang dimiliki oleh Ruang. Tindakan ini tidak dapat diurungkan.

Untuk menghapus Ruang menggunakan UI Apigee:

1. Di UI Apigee di Konsol Cloud, buka halaman Ruang.
2. Klik Hapus di baris Ruang yang ingin Anda hapus.
3. Pada dialog konfirmasi, ketik nama Ruang yang tepat untuk mengonfirmasi.
4. Klik Hapus.

Catatan: Jika Ruang masih berisi resource aktif, penghapusan akan gagal. Hapus atau pindahkan semua resource di Ruang sebelum mencoba menghapusnya.

Apigee API

Sebelum menghapus Ruang menggunakan API, pastikan semua resource di Ruang telah dihapus atau dipindahkan.

curl -X DELETE -H "Authorization: Bearer $TOKEN" \
    "https://apigee.googleapis.com/v1/organizations/ORG_NAME/spaces/SPACE_NAME"

Dengan:

• ORG_NAME adalah nama organisasi Apigee Anda.
• SPACE_NAME adalah nama Ruang.

Jika Anda mencoba menghapus Ruang yang masih berisi resource aktif, penghapusan akan gagal dengan respons yang mirip dengan berikut:

{
  "error": {
    "code": 400,
    "message": "Space \"red\" has resources associated with it. Please delete the resources before deleting the space.",
    "status": "FAILED_PRECONDITION"
  }
}

Untuk mengatasi error ini, hapus atau pindahkan semua resource di Ruang sebelum mencoba menghapusnya.

Langkah berikutnya

• Pelajari lebih lanjut Apigee Spaces.
• Pelajari cara Mengelola resource API dengan Apigee Spaces.
• Tinjau dokumentasi Identity and Access Management (IAM).