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

שימוש ב-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.