Tentang acurl dan get_token

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

Apigee menyediakan utilitas praktis berikut untuk membuat dan meneruskan akses OAuth2 dan token refresh. Anda menggunakan token ini untuk mengautentikasi diri sendiri dalam panggilan Edge API dengan OAuth (termasuk alur kerja SAML dan LDAP):

  • acurl(1): Menyediakan wrapper praktis di sekitar perintah curl standar. Membuat permintaan HTTP ke Edge API, mendapatkan akses dan token refresh dari get_token, serta meneruskan token akses ke Edge API.
  • get_token(1): Menukarkan kredensial Apigee Anda dengan token akses dan refresh yang dapat Anda gunakan untuk memanggil Edge API.

Kedua utilitas ini menukar kredensial akun Apigee Anda (nama pengguna dan sandi, atau kode sandi) dengan token OAuth2.

Token yang dibuat oleh utilitas Apigee sesuai dengan spesifikasi Framework Otorisasi OAuth 2.0.

Menggunakan utilitas Apigee untuk mendapatkan token atau mengakses server autentikasi untuk Edge API bersifat opsional. Anda dapat menerapkan skema Anda sendiri untuk membuat token akses OAuth2 dan mengirimkannya dalam permintaan Anda ke Edge API.

Menginstal acurl dan get_token

Apigee menyediakan file ZIP yang berisi acurl(1), get_token(1), dan skrip penginstalan.

Untuk menginstal acurl dan get_token:

  1. Buat direktori penginstalan di komputer Anda atau gunakan direktori usr/local/bin default.
  2. Download file ZIP penginstalan dari Apigee:
    curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
  3. Ekstrak file yang didownload.
  4. Jalankan skrip penginstalan:
    sudo ./install -b /usr/local/bin

    Opsi -b menentukan lokasi file yang dapat dieksekusi. Jika Anda tidak menetapkan opsi ini, skrip penginstalan akan menginstal utilitas di /usr/local/bin.

  5. Uji penginstalan:
        acurl -h
        get_token -h

    Jika penginstalan berhasil, perintah ini akan menampilkan teks Bantuan untuk utilitas tersebut.

Akhir masa berlaku token

acurl dan get_token membuat token dengan durasi berikut:

  • Masa berlaku token akses berakhir dalam 12 jam.
  • Masa berlaku token refresh berakhir dalam 30 hari.

Oleh karena itu, setelah berhasil melakukan panggilan API dengan acurl atau get_token, Anda dapat terus menggunakan pasangan token selama 30 hari. Setelah masa berlakunya habis, Anda harus memasukkan kembali kredensial dan mendapatkan token baru.

Menetapkan endpoint SSO

Sebelum melakukan panggilan pertama, Anda harus menetapkan endpoint server otorisasi untuk Edge API yang ingin digunakan dengan acurl dan get_token.

Dari terminal, tetapkan variabel lingkungan SSO_LOGIN_URL ke endpoint server otorisasi. Contoh:

  • Untuk pelanggan Cloud tanpa zona:
    export SSO_LOGIN_URL=https://login.apigee.com
  • Untuk pelanggan Cloud dengan zona:
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • Untuk pelanggan Private Cloud, hubungi administrator Anda untuk mengetahui endpoint SSO yang sesuai.

Gunakan kode sandi sekali pakai (diperlukan untuk SAML)

Saat melakukan panggilan API dengan acurl atau get_token, Anda harus mengautentikasi diri Anda sendiri ke utilitas untuk menerima pasangan token. Anda dapat melakukannya dengan meneruskan nama pengguna, sandi, dan kode MFA akun Apigee Anda. Namun, jika menggunakan IDP SAML atau tidak ingin menggunakan sandi, Anda bisa mendapatkan kode sandi kode sekali pakai untuk digunakan.

Untuk mendapatkan kode sandi sekali pakai:

  1. Masukkan URL berikut di browser:
    • Untuk pelanggan Cloud tanpa zona:
      https://login.apigee.com/passcode
    • Untuk pelanggan Cloud dengan zona:
      https://zone_name.login.apigee.com/passcode
    • Untuk pelanggan Private Cloud, hubungi administrator Anda untuk mengetahui endpoint SSO yang sesuai.
  2. Login ke akun Apigee Anda.
  3. Salin kode sandi 6 karakter.
  4. Gunakan acurl atau get_token dengan opsi -p dan teruskan kode sandi, seperti pada contoh berikut:
    get_token -p 1a2b3c

Melihat token Anda

Setelah Anda berhasil menjalankan acurl atau get_token, utilitas akan membuat file data dalam ~/.sso-cli yang berisi token dan metadata lainnya.

Untuk melihat token, Anda dapat menggunakan perintah seperti berikut:

get_token -v

Perintah ini menampilkan klaim token yang didekode, misalnya:

Decoded token claims:
 {
  "jti": "8018507e-9f34-4a90-bf97-ff226a06b19b",
  "sub": "858217a9-01a1-4111-8525-75ca555f5d5c",
  "scope": [
    "scim.emails.read",
    "scim.me",
    "openid",
    "password.write",
    "approvals.me",
    "scim.ids.read",
    "oauth.approvals"
          ],
  "client_id": "edgecli",
  "cid": "edgecli",
  "azp": "edgecli",
  "grant_type": "password",
  "user_id": "858217a9-01a1-4111-8525-75ca555f5d5c",
  "origin": "usergrid",
  "user_name": "myusername@google.com",
  "email": "myusername@google.com",
  "auth_time": 1597444772,
  "al": 0,
  "rev_sig": "6271c527",
  "iat": 1597444772,
  "exp": 1597487972,
  "iss": "https://login.apigee.com",
  "zid": "uaa",
  "aud": [
    "edgecli",
    "scim.emails",
    "scim",
    "openid",
    "password",
    "approvals",
    "scim.ids",
    "oauth"
        ]
    }
Current timestamp: 1597444983
Existing access token is still valid

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