שימוש ב-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 אופציונלי קוד זמני של אימות רב-שלבי (MFA) בן שש ספרות. הקוד הזה נדרש אם משתמשים ב--u ומופעלת בו MFA. אם הושמט (אלא אם מגדירים קוד סיסמה), תוצג הודעה. אם MFA לא מופעל, או אם יש לך תהליך סקריפט, ניתן לציין -m "" כדי להימנע מבקשות.
PASSCODE אופציונלי. צריך שילוב של שם משתמש וסיסמה או קוד סיסמה. קוד סיסמה חד-פעמי שאפשר להשתמש בו במקום הסיסמה. יש להזין קוד גישה כשמתבצע אימות באמצעות IdP של SAML, וניתן להשתמש בו כדי לאמת באמצעות LDAP IDP.

לדוגמה:

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.
  • שם המשתמש, הסיסמה וקוד MFA זמני, אחרת.

בדוגמה הבאה מתבצעת קריאה ל-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". בחומר העזר בנושא Apigee Edge API תוכלו למצוא רשימה מלאה של נקודות הקצה של Edge API.

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

אפשר להשתמש בכלי העזר get_token עם SAML, LDAP או כל IdP אחר. ב-get_token יש תמיכה במספר כתובות URL לכניסה מסוג 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.