Anda sedang melihat dokumentasi Apigee Edge.
Buka
Dokumentasi Apigee X. info
Utilitas get_token
(1) memungkinkan Anda bertukar kredensial Apigee untuk mendapatkan akses
token baru yang bisa digunakan
untuk mengakses Edge API. Token ini juga dapat digunakan dengan SAML
dan implementasi LDAP dari alur kerja OAuth2.
get_token
memungkinkan Anda untuk:
- Dapatkan token akses atau refresh.
- Mencetak token ke
stdout
untuk digunakan dalam variabel dan perintah. - Simpan token di disk Anda.
Selanjutnya, Anda dapat menambahkan token yang valid dalam permintaan ke Edge API dan mendapatkan token baru saat masa berlaku token Anda berakhir.
Prasyarat: Sebelum dapat menggunakan get_token
, Anda harus
instal.
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? | Deskripsi |
---|---|---|
USERNAME | Opsional. Kombinasi nama pengguna dan sandi atau kode sandi diperlukan. | Nama pengguna Apigee Anda, biasanya adalah alamat email yang terkait dengan akun Apigee Anda.
Anda harus meneruskan nama pengguna atau kode sandi saat pertama kali memanggil get_token .
Anda tidak perlu meneruskan email Anda
masuk kembali hingga masa berlaku token akses dan token telah habis. Jika Anda meng-cache token
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 Anda menghilangkan {i>password<i}, Anda akan diminta untuk
masukkan saat pertama kali Anda menggunakan get_token dan pada panggilan berikutnya tanpa
token refresh. Jika Anda tidak ingin menggunakan {i>password<i} Anda secara
langsung di dalam perintah, Anda dapat menggunakan
kode sandi sekali pakai
alih-alih {i>password<i} Anda. |
MFACODE | Opsional | Enam digit sementara multi-faktor
kode autentikasi (MFA). Kode ini diperlukan jika Anda menggunakan -u dan mengaktifkan MFA.
Anda akan diminta jika dihilangkan (kecuali dalam mode kode sandi). Jika Anda tidak mengaktifkan MFA,
atau memiliki alur dengan skrip, Anda dapat menentukan -m "" untuk menghindari dialog. |
PASSCODE | Opsional. Kombinasi nama pengguna dan sandi atau kode sandi diperlukan. | Kode sandi sekali pakai yang dapat Anda gunakan sebagai pengganti {i>password<i}. Kode sandi diperlukan saat mengautentikasi dengan IDP SAML, dan dapat digunakan untuk melakukan otentikasi dengan IDP LDAP. |
Contoh:
get_tokenget_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
mengakses dan memuat ulang token di ~/.sso-cli
. Anda dapat menggunakan
token ini sampai
masa berlaku, seperti yang dijelaskan dalam Masa berlaku token.
Setelah panggilan pertama ke get_token
berhasil, Anda tidak perlu menyertakan
kredensial hingga masa berlaku token habis.
Memanggil get_token untuk pertama kalinya
Jika Anda tidak menentukan opsi apa pun dalam panggilan pertama, get_token
akan meminta Anda untuk
hal berikut:
- Kode sandi, jika melakukan autentikasi dengan penyedia identitas (IDP) SAML.
- Nama pengguna, sandi, dan kode MFA sementara, jika tidak.
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 Anda ke Edge API melalui beberapa cara.
Anda dapat:
- Salin konten respons
get_token
dan sisipkan langsung ke {i>header<i}:curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \ -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
- Gabungkan perintah untuk mendapatkan token dan tambahkan 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$(...)
, jadi yang dijalankan. - Panggil
get_token
dalam panggilancurl
:curl -H "Authorization: Bearer $(get_token)" \ https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval
Perhatikan bahwa
get_token
menggunakan sintaksis substitusi perintah$(...)
, jadi yang dijalankan.
Contoh permintaan ini mendapatkan detail tentang nilai "ahamilton-eval" organisasi/pengaturan. Untuk daftar lengkap endpoint Edge API, lihat Referensi Apigee Edge API.
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
$HOME/.sso-cli
menghapus akses yang di-cache dan token refresh untuk server.--clear-all-sso-cache
Menghapus semua direktori di bagian
$HOME/.sso-cli
yang menghapus semua token yang di-cache.
(1) Hak Cipta 2023 Google LLC
Alat get_token
tersedia sebagai "Software" di bawah
perjanjian yang mengatur penggunaan Anda atas Google Cloud Platform, termasuk Layanan
Persyaratan Khusus tersedia di https://cloud.google.com/terms/service-terms.