שימוש ב-get_token

אתם צופים במסמכי התיעוד של Apigee Edge.
כדאי לעיין במסמכי התיעוד של Apigee X.
מידע

הכלי get_token(1) מאפשר להחליף את פרטי הכניסה שלכם ב-Apigee באסימון גישה ובאסימון רענון שבהם תוכלו להשתמש כדי לגשת לממשקי API של Edge. אפשר להשתמש באסימונים גם בהטמעות של SAML ו-LDAP של תהליכי עבודה של OAuth2.

get_token מאפשר לכם:

  • מקבלים אסימון גישה או אסימון רענון.
  • הדפסת אסימונים ל-stdout לשימוש במשתנים ובפקודות.
  • אחסון טוקנים בדיסק.

לאחר מכן תוכלו להוסיף אסימון תקין לבקשות שלכם ל-Edge API ולקבל אסימון חדש כשהתוקף של האסימון הנוכחי יפוג.

דרישה מוקדמת: כדי להשתמש ב-get_token, צריך להתקין אותו.

התחביר של get_token

כלי השירות get_token משתמש בתחביר הבא:

get_token -u USERNAME:PASSWORD [-m MFACODE]

או

get_token -p passcode

כאשר:

רכיב חובה? תיאור
USERNAME אופציונלי. נדרש שם משתמש וסיסמה או קוד גישה. שם המשתמש שלכם ב-Apigee, שהוא בדרך כלל כתובת האימייל שמשויכת לחשבון שלכם ב-Apigee. בפעם הראשונה שמתקשרים אל get_token, צריך להזין את שם המשתמש או קוד אימות. לא תצטרכו להעביר שוב את כתובת האימייל עד שתוקף האסימונים של הגישה והרענון יפוג. אם אתם שומרים במטמון טוקנים של יותר ממשתמש אחד, אתם צריכים לציין את שם המשתמש בכל קריאה.
PASSWORD אופציונלי. נדרש שם משתמש וסיסמה או קוד גישה. הסיסמה לחשבון Apigee. אם לא תזינו את הסיסמה, תתבקשו להזין אותה בפעם הראשונה שתשתמשו ב-get_token ובכל שיחה שלאחר מכן ללא טוקן רענון תקין. אם אתם לא רוצים להשתמש בסיסמה שלכם ישירות בפקודה, אתם יכולים להשתמש בקוד גישה חד-פעמי במקום בסיסמה.
MFACODE אופציונלי קוד זמני בן 6 ספרות של אימות רב-שלבי (MFA). הקוד הזה נדרש אם אתם משתמשים ב--u והפעלתם אימות דו-שלבי. אם לא תזינו את הסיסמה, תופיע בקשה להזין אותה (אלא אם המכשיר במצב קוד גישה). אם לא הפעלתם אימות דו-שלבי או אם יש לכם תהליך מבוסס-סקריפט, אתם יכולים לציין -m "" כדי להימנע מהנחיות.
PASSCODE אופציונלי. נדרש שם משתמש וסיסמה או קוד גישה. קוד אימות חד-פעמי שאפשר להשתמש בו במקום בסיסמה. כשמבצעים אימות באמצעות ספק זהויות SAML, נדרש קוד גישה. אפשר להשתמש בקוד גישה גם כדי לבצע אימות באמצעות ספק זהויות LDAP.

לדוגמה:

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

קריאה מוצלחת מדפיסה טוקן גישה תקין ב-stdout ומאחסנת את טוקן הגישה וטוקן הרענון ב-~/.sso-cli. אפשר להשתמש באסימונים האלה עד שהתוקף שלהם יפוג, כמו שמתואר במאמר בנושא תפוגת תוקף של אסימונים.

אחרי שהשיחה הראשונה אל get_token מסתיימת בהצלחה, לא צריך לכלול את פרטי הכניסה עד שתוקף הטוקנים יפוג.

התקשרות אל get_token בפעם הראשונה

אם לא מציינים אפשרויות בשיחה הראשונה, get_token יציג את ההנחיות הבאות:

  • קוד גישה, אם האימות מתבצע באמצעות ספק זהויות (IDP) SAML.
  • שם המשתמש, הסיסמה וקוד אימות זמני, אחרת.

בדוגמה הבאה מתבצעת קריאה ל-get_token בפעם הראשונה, ונעשה שימוש בשם משתמש ובסיסמה עם קוד MFA אופציונלי לאימות:

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

הוספת טוקן גישה לבקשה

אחרי שקוראים ל-get_token בהצלחה, אפשר להשתמש בטוקן הגישה בכמה דרכים. לשם כך, מעבירים אותו בכותרת Authorization של הקריאות ל-Edge API. אתם יכולים:

  • מעתיקים את התוכן של התגובה get_token ומדביקים אותו ישירות בכותרת:
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
      -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • משלבים פקודות כדי לקבל את האסימון ולהוסיף אותו לכותרת:
    token=$(get_token); curl -H "Authorization: Bearer $token" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    שימו לב: get_token משתמש בתחביר של החלפת פקודות $(...) כדי שהפקודה תופעל.

  • מתקשרים אל get_token במהלך השיחה עם curl:
    curl -H "Authorization: Bearer $(get_token)" \
      https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    שימו לב: get_token משתמש בתחביר של החלפת פקודות $(...) כדי שהפקודה תופעל.

בקשות לדוגמה שמקבלות פרטים על הארגון ahamilton-eval. רשימה מלאה של נקודות קצה (endpoints) של Edge API מופיעה במאמר Apigee Edge API Reference.

שימוש ב-get_token עם SAML ו-LDAP

אפשר להשתמש בכלי get_token עם SAML, ‏ LDAP או כל ספק זהויות בסיסי אחר. ב-get_token יש תמיכה בשימוש במספר כתובות אתר לכניסה באמצעות SSO ובמספר חשבונות. משתמש יחיד עם כמה חשבונות יתבקש לציין את שם המשתמש לכל שיחה ב-get_token.

ניקוי המטמון של get_token

אפשר להשתמש בדגלים האופציונליים הבאים כדי לנקות את המטמון של get_token:

  • --clear-sso-cache

    מנקה את ספריית המטמון של SSO_LOGIN_URL ב-$HOME/.sso-cli ומבטל את כל אסימוני הגישה והרענון ששמורים במטמון של השרת.

  • --clear-all-sso-cache

    מחיקת כל הספריות ב-$HOME/.sso-cli וביטול כל הטוקנים שבמטמון.


(1) זכויות יוצרים © 2023 Google LLC
הכלי get_token זמין כ'תוכנה' בהתאם להסכם שחל על השימוש שלכם ב-Google Cloud Platform, כולל התנאים הספציפיים לשירות שזמינים בכתובת https://cloud.google.com/terms/service-terms.