Menggunakan apigee-ssoadminapi.sh

Edge for Private Cloud v4.19.01

Modul SSO Edge mendukung dua jenis akun:

  • administrator
  • pengguna perangkat (khusus SAML)

Utilitas apigee-ssoadminapi.sh memungkinkan Anda mengelola pengguna administrator dan mesin yang terkait dengan modul SSO Edge.

Gunakan utilitas apigee-ssoadminapi.sh untuk:

  • Melihat daftar pengguna admin/mesin
  • Menambahkan atau menghapus pengguna admin/mesin
  • Mengubah sandi pengguna admin/mesin

Tentang pengguna administrator

Akun administrator di modul SSO Edge diperlukan untuk mengelola properti modul.

Secara default, saat Anda menginstal modul SSO Edge, modul ini akan membuat akun administrator dengan kredensial berikut:

  • username: Ditentukan oleh properti SSO_ADMIN_NAME dalam file konfigurasi yang digunakan untuk mengonfigurasi modul Edge SSO. Defaultnya adalah ssoadmin.
  • password: Ditentukan oleh properti SSO_ADMIN_SECRET dalam file konfigurasi yang digunakan untuk mengonfigurasi modul SSO Edge.

Tentang pengguna mesin

Pengguna mesin dapat memperoleh token OAuth2 tanpa harus menentukan kode sandi. Artinya, Anda dapat sepenuhnya mengotomatiskan proses mendapatkan dan memperbarui token OAuth2 menggunakan API pengelolaan Edge.

Anda biasanya menggunakan pengguna mesin untuk:

  • Mengonfigurasi portal Layanan Developer Apigee (atau cukup, portal) untuk berkomunikasi dengan Edge
  • Saat lingkungan pengembangan mendukung otomatisasi untuk tugas pengembangan umum, seperti otomatisasi pengujian atau Continuous Integration/Continuous Deployment (CI/CD).

Untuk mengetahui informasi selengkapnya, lihat Menggunakan SAML dengan tugas otomatis.

Menginstal apigee-ssoadminapi.sh

Instal utilitas apigee-ssoadminapi.sh di node Server Pengelolaan Edge tempat Anda menginstal modul SSO Edge. Biasanya, Anda menginstal utilitas apigee-ssoadminapi.sh saat menginstal modul SSO Edge.

Jika Anda belum menginstal utilitas apigee-ssoadminapi.sh:

  1. Login ke node Server Pengelolaan. Node tersebut seharusnya sudah menginstal apigee-service seperti yang dijelaskan di Menginstal utilitas apigee-setup Edge.
  2. Instal utilitas apigee-ssoadminapi.sh yang digunakan untuk mengelola pengguna admin dan mesin untuk modul SSO Edge: 
    /opt/apigee/apigee-service/bin/apigee-service apigee-ssoadminapi install
  3. Logout dari shell, lalu login kembali untuk menambahkan utilitas apigee-ssoadminapi.sh ke jalur Anda.

Melihat informasi bantuan untuk apigee-ssoadminapi.sh

Perintah yang tersedia untuk utilitas ini adalah:

  • admin add
  • admin delete
  • admin list
  • admin setpassword
  • saml machineuser add
  • saml machineuser delete
  • aaml machineuser list
  • saml machineuser setpassword

Anda dapat melihat informasi tentang perintah ini di file /opt/apigee/apigee-ssoadminapi/README.md. Selain itu, Anda dapat menentukan opsi "-h" untuk setiap perintah guna melihat informasi penggunaan.

Misalnya, perintah berikut:

apigee-ssoadminapi.sh admin list -h

Returns:

admin list
  --admin SSOADMIN_CLIENT_NAME      Name of the client having administrative privilege on sso
  --secret SSOADMIN_CLIENT_SECRET   Secret/Password for the client
  --host SSO_HOST                   Hostname of SSO server to connect
  --port SSO_PORT                   Port to use during request
  --ssl SSO_URI_SCHEME              Set to https, defaults to http
  --debug                           Set in debug mode, turns on verbose in curl
  -h                                Displays Help

Memanggil utilitas apigee-ssoadminapi.sh

Anda dapat memanggil utilitas apigee-ssoadminapi.sh dengan meneruskan semua properti sebagai argumen command line, atau dalam mode interaktif dengan merespons perintah.

Misalnya, untuk menentukan semua informasi yang diperlukan di command line guna melihat daftar pengguna admin:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123 --host 35.197.94.184

Returns:

[
  {
    "client_id": "ssoadmin",
    "access_token_validity": 300
  }
]

Jika Anda menghilangkan informasi yang diperlukan, seperti sandi admin, Anda akan diminta untuk memasukkannya.

Dalam contoh ini, Anda menghilangkan nilai untuk --port dan --ssl karena modul Edge SSO menggunakan nilai default 9099 untuk --port dan http untuk --ssl. Jika penginstalan Anda tidak menggunakan setelan default ini, tentukan:

apigee-ssoadminapi.sh admin list --admin ssoadmin --secret Secret123
  --host 35.197.94.184 --port 9443 --ssl https

Atau, gunakan formulir interaktif yang meminta Anda memberikan semua informasi:

apigee-ssoadminapi.sh admin list

Kemudian, Anda akan diminta untuk memberikan semua informasi yang diperlukan:

SSO admin name (current): ssoadmin
SSO Admin secret (current):
SSO host: 35.197.94.184