Menggunakan utilitas admin dan API Edge setelah mengaktifkan SAML

Bagian ini menjelaskan cara menjalankan perintah dan alat admin sistem Edge setelah mengaktifkan SAML. Banyak tugas di Edge memerlukan kredensial administrasi sistem, seperti:

  • Membuat organisasi dan lingkungan
  • Menambahkan dan menghapus komponen Edge
  • Perintah apigee-adminapi.sh runngin

Namun, setelah mengaktifkan SAML di Edge, Anda biasanya menonaktifkan Basic Auth sehingga satu-satunya cara untuk mengautentikasi adalah melalui IDP SAML. Oleh karena itu, Anda harus memastikan bahwa Anda telah menambahkan akun admin sistem ke IDP SAML.

Memanggil API pengelolaan Edge sebagai administrator sistem

Banyak panggilan Edge API mengharuskan Anda meneruskan kredensial administrator sistem. Menggunakan SAML dengan Edge management API berisi petunjuk tentang cara mendapatkan dan memperbarui token saat melakukan panggilan API pengelolaan Edge.

Menggunakan utilitas apigee-adminapi.sh dengan autentikasi SAML

Gunakan utilitas apigee-adminapi.sh untuk melakukan tugas konfigurasi Edge yang sama seperti yang Anda lakukan dengan melakukan panggilan ke Edge Management API. Keuntungan bagi utilitas apigee-adminapi.sh adalah:

  • Menggunakan antarmuka command line sederhana
  • Menerapkan penyelesaian perintah berbasis tab
  • Memberikan bantuan dan informasi penggunaan
  • Dapat menampilkan panggilan API yang sesuai jika Anda memutuskan untuk mencoba API

Untuk informasi selengkapnya, lihat Menggunakan apigee-ssoadminapi.sh.

Setelah mengaktifkan autentikasi SAML, Anda memiliki beberapa cara untuk meneruskan kredensial admin sistem ke utilitas apigee-adminapi.sh.

Anda dapat melihat semua opsi untuk perintah apigee-adminapi.sh apa pun, termasuk opsi untuk menentukan kredensial SAML, dengan menggunakan opsi "-h" pada perintah tersebut. Contoh: 

apigee-adminapi.sh orgs list -h

Misalnya, Anda dapat meneruskan kredensial admin sistem:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow password_grant \
  --admin adminEmail --oauth-password adminPword

Dengan keterangan:

  • Opsi sso-url menentukan URL modul SSO Apigee. Ubah port atau protokol jika Anda telah mengubahnya dari 9099 dan HTTP.
  • oauth-flow menentukan passcode atau password_grant. Dalam contoh ini, Anda menentukan password_grant.
  • adminEmail adalah alamat email admin sistem.
  • oauth-password menentukan sandi admin sistem.

Atau, Anda dapat menggunakan kode sandi saat memanggil perintah:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-passcode passcode

Dengan keterangan:

  • oauth-flow menentukan passcode.
  • oauth-passcode menentukan kode sandi yang diperoleh dari http://edge_sso_IP_DNS:9099/passcode.

Terakhir, Anda dapat menggunakan token saat memanggil perintah:

apigee-adminapi.sh orgs list --sso-url http://edge_sso_IP_DNS:9099 --oauth-flow passcode \
  --admin adminEmail --oauth-token token

Dengan keterangan:

  • oauth-flow menentukan passcode atau password_grant, bergantung pada cara Anda awalnya mendapatkan token. Dalam contoh ini, Anda harus menentukan passcode karena awalnya Anda mendapatkan token menggunakan get_token. Lihat Menggunakan SAML dengan Edge management API.
  • oauh_token berisi token.

Menggunakan utilitas Edge dengan autentikasi SAML

Banyak utilitas Edge memerlukan kredensial admin sistem, seperti:

  • apigee-provision digunakan untuk membuat organisasi, lingkungan, dan host virtual
  • setup.sh digunakan untuk menambahkan node ke sistem yang ada
  • Utilitas lainnya yang mengharuskan Anda menetapkan kredensial admin sistem pada file konfigurasi

Utilitas ini mengambil file konfigurasi sebagai input yang menentukan kredensial admin sistem dengan menggunakan properti:

ADMIN_EMAIL="adminEmail"
APIGEE_ADMINPW=adminPWord

Jika Anda menghapus sandi, Anda akan diminta untuk mengisinya.

Setelah mengaktifkan SAML, Anda dapat menggunakan properti lain untuk menentukan kredensial admin sistem. Misalnya, Anda dapat meneruskan kredensial admin sistem:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=password_grant
OAUTH_ADMIN_PASSWORD=adminPWord

Dengan keterangan:

  • SSO_LOGIN_URL menentukan URL modul SSO Apigee. Ubah port atau protokol jika Anda telah mengubahnya dari 9099 dan HTTP.
  • OAUTH_FLOW menentukan passcode atau password_grant. Dalam contoh ini, Anda menentukan password_grant karena Anda meneruskan sandi admin sistem.
  • OAUTH_ADMIN_PASSWORD menentukan sandi admin sistem.

Atau, Anda dapat menggunakan properti berikut untuk menentukan kredensial sebagai bagian dari alur kode sandi:

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_ADMIN_PASSCODE=passcode

Dengan keterangan:

  • OAUTH_FLOW menentukan passcode.
  • OAUTH_ADMIN_PASSCODE menentukan kode sandi yang diperoleh dari http://edge_sso_IP_DNS:9099/passcode.

Terakhir, Anda dapat menggunakan token

ADMIN_EMAIL="adminEmail"
SSO_LOGIN_URL=http://edge_sso_IP_DNS:9099
OAUTH_FLOW=passcode
OAUTH_BEARER_TOKEN=token

Dengan keterangan:

  • OAUTH_FLOW menentukan passcode atau password_grant, bergantung pada cara Anda awalnya mendapatkan token. Dalam contoh ini, Anda menentukan passcode karena awalnya Anda mendapatkan token menggunakan get_token. Lihat Menggunakan SAML dengan Edge management API.
  • OAUTH_BEARER_TOKEN berisi token.