Menggunakan get_token

Anda sedang melihat dokumentasi Apigee Edge.
Buka dokumentasi Apigee X. info

Utilitas get_token(1) memungkinkan Anda menukar kredensial Apigee dengan token akses dan refresh yang dapat Anda gunakan untuk mengakses Edge API. Token ini juga dapat digunakan dengan implementasi SAML dan LDAP untuk alur kerja OAuth2.

get_token memungkinkan Anda untuk:

  • Dapatkan token akses atau refresh.
  • Mencetak token ke stdout untuk digunakan dalam variabel dan perintah.
  • Menyimpan token di {i>disk<i} Anda.

Anda kemudian dapat menambahkan token yang valid dalam permintaan ke Edge API dan mendapatkan token baru saat permintaan Anda tidak berlaku lagi.

Prasyarat: Sebelum dapat menggunakan get_token, Anda harus menginstalnya.

sintaksis get_token

Utilitas get_token menggunakan sintaksis berikut:

get_token -u USERNAME:PASSWORD [-m MFACODE]

atau

get_token -p passcode

Dengan keterangan:

Elemen Wajib diisi? Deskripsi
USERNAME Opsional. Kombinasi nama pengguna dan sandi atau kode sandi diperlukan. Nama pengguna Apigee Anda, yang biasanya merupakan alamat email yang terkait dengan akun Apigee Anda. Anda harus memasukkan nama pengguna atau kode sandi saat pertama kali memanggil get_token. Anda tidak perlu meneruskan alamat email lagi hingga token akses dan refresh telah habis masa berlakunya. Jika menyimpan token dalam cache untuk lebih dari satu pengguna, Anda harus menentukan nama pengguna dalam setiap panggilan.
PASSWORD Opsional. Kombinasi nama pengguna dan sandi atau kode sandi diperlukan. Sandi untuk akun Apigee Anda. Jika menghapus sandi, Anda akan diminta untuk memasukkannya saat pertama kali menggunakan get_token dan pada panggilan berikutnya tanpa token refresh yang valid. Jika tidak ingin menggunakan sandi langsung di perintah, Anda dapat menggunakan kode sandi kode sekali pakai, bukan sandi Anda.
MFACODE Opsional Kode autentikasi multi-faktor (MFA) enam digit sementara. Kode ini diperlukan jika Anda menggunakan -u dan telah mengaktifkan MFA. Anda akan diminta untuk melakukannya jika dihilangkan (kecuali dalam mode kode sandi). Jika MFA tidak diaktifkan, atau Anda memiliki alur dengan skrip, Anda dapat menentukan -m "" untuk menghindari perintah.
PASSCODE Opsional. Kombinasi nama pengguna dan sandi atau kode sandi diperlukan. Kode sandi sekali pakai yang dapat Anda gunakan sebagai pengganti sandi. Kode sandi diperlukan saat melakukan autentikasi dengan IDP SAML, dan dapat digunakan untuk melakukan autentikasi dengan IDP LDAP.

Contoh:

get_token
get_token -u ahamilton@apigee.com:mypassw0rd -m 424242
get_token -p mypass

Panggilan yang berhasil akan mencetak token akses yang valid ke stdout dan menyimpan token akses dan refresh di ~/.sso-cli. Anda dapat menggunakan token ini hingga masa berlakunya habis, seperti yang dijelaskan dalam Masa berlaku token.

Setelah panggilan pertama Anda yang berhasil ke get_token, Anda tidak perlu menyertakan kredensial Anda sampai masa berlaku token habis.

Memanggil get_token untuk pertama kalinya

Jika Anda tidak menentukan opsi apa pun dalam panggilan pertama, get_token akan meminta hal berikut:

  • Kode sandi, jika melakukan autentikasi dengan penyedia identitas (IDP) SAML.
  • Nama pengguna, sandi, dan kode MFA sementara Anda.

Contoh berikut memanggil get_token untuk pertama kalinya dan menggunakan kombinasi nama pengguna/sandi dengan kode MFA opsional untuk autentikasi:

get_token
Enter username:
ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
123456

ey42bGciOiJSUzI1NiJ9.eyJqdGkiOiJhM2YwNjA5ZC1lZTIxLTQ1YjAtOGQyMi04MTQ0MTYxNjNhNTMiLCJzdWIiOiIyZDFl
  <snip>
VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbSIsIm9wZW5pZCIsInBhc3N3b3JkIiwiYXBwcm54242

Menambahkan token akses ke permintaan

Setelah berhasil memanggil get_token, Anda dapat menggunakan token akses dengan meneruskannya di header Authorization panggilan ke Edge API melalui beberapa cara. Anda dapat:

  • Salin konten respons get_token dan masukkan langsung ke header Anda: 
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
  -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • Gabungkan perintah untuk mendapatkan token dan menambahkannya ke header: 
    token=$(get_token); curl -H "Authorization: Bearer $token" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Perhatikan bahwa get_token menggunakan sintaksis substitusi perintah $(...) sehingga dapat dieksekusi.

  • Panggil get_token dalam panggilan curl: 
    curl -H "Authorization: Bearer $(get_token)" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    Perhatikan bahwa get_token menggunakan sintaksis substitusi perintah $(...) sehingga dapat dieksekusi.

Permintaan contoh ini mendapatkan detail tentang organisasi "ahamilton-eval". Untuk mengetahui daftar lengkap endpoint Edge API, lihat Referensi API Apigee Edge.

Menggunakan get_token dengan SAML dan LDAP

Utilitas get_token dapat digunakan dengan SAML, LDAP, atau IDP dasar lainnya. get_token mendukung penggunaan beberapa URL login SSO dan beberapa akun. Satu pengguna dengan beberapa akun akan diminta untuk menentukan nama pengguna untuk setiap panggilan get_token.

Menghapus cache get_token

Anda dapat menggunakan tanda opsional berikut untuk menghapus cache get_token:

  • --clear-sso-cache

    Menghapus direktori cache untuk SSO_LOGIN_URL di bagian $HOME/.sso-cli, yang menghapus akses yang disimpan dalam cache dan token refresh untuk server.

  • --clear-all-sso-cache

    Menghapus semua direktori di bagian $HOME/.sso-cli yang menghapus semua token yang disimpan dalam cache.

(1) Hak Cipta 2023 Google LLC
Alat get_token tersedia sebagai "Software" berdasarkan perjanjian yang mengatur penggunaan Anda atas Google Cloud Platform, termasuk Persyaratan Khusus Layanan yang tersedia di https://cloud.google.com/terms/service-terms.