מידע על acurl ו-get_token

כרגע מוצג התיעוד של Apigee Edge.
כניסה למסמכי התיעוד של Apigee X. מידע

Apigee מספק את אמצעי הנוחות הבאים ליצירה ולהעברה של אסימוני גישה ורענון ל-OAuth2. האסימונים האלה משמשים לאימות הזהות שלך בקריאות ל-Edge API באמצעות OAuth (כולל תהליכי עבודה של SAML ו-LDAP):

  • acurl(1): הוספת ממשק wrapper סביב פקודת curl רגילה. יצירת בקשות HTTP ל-Edge API, קבלת אסימוני גישה ורענון מ-get_token והעברת אסימון הגישה ל-API של Edge.
  • get_token(1): ממיר את פרטי הכניסה של Apigee לאסימוני גישה ואסימוני רענון שאפשר להשתמש בהם כדי לקרוא ל-Edge API.

שני הכלים האלה מחליפים את פרטי הכניסה לחשבון Apigee (שם משתמש וסיסמה, או קוד גישה) באסימוני OAuth2.

האסימונים שנוצרו על ידי כלי העזר של Apigee תואמים למפרט של מסגרת ההרשאות של OAuth 2.0.

השימוש בכלים של Apigee לקבלת אסימונים או גישה לשרת האימות עבור ממשקי API של Edge הוא אופציונלי. יש לך אפשרות להטמיע סכמות משלך כדי ליצור אסימוני גישה מסוג OAuth2 ולשלוח אותם בבקשות שלך ל-Edge API.

התקנת acurl ו-get_token

Apigee מספקת קובץ ZIP שמכיל acurl(1), get_token(1) וסקריפט להתקנה.

כדי להתקין את acurl ואת get_token:

  1. יוצרים ספריית התקנה במחשב או משתמשים בספריית ברירת המחדל usr/local/bin.
  2. מורידים את קובץ ה-ZIP של ההתקנה מ-Apigee: 
    curl https://login.apigee.com/resources/scripts/sso-cli/ssocli-bundle.zip -O
  3. מחלצים את הקובץ שהורד.
  4. מריצים את סקריפט ההתקנה: 
    sudo ./install -b /usr/local/bin

    האפשרות -b מציינת את המיקום של קובצי ההפעלה. אם לא מציינים את האפשרות הזו, סקריפט ההתקנה יתקין את הכלים ב-/usr/local/bin.

  5. בודקים את ההתקנות: 
        acurl -h
    get_token -h

    אם ההתקנה תתבצע בהצלחה, הפקודות האלה יחזירו טקסט עזרה עבור הכלים.

תפוגת האסימון

acurl ו-get_token יוצרים אסימונים במשכי הזמן הבאים:

  • התוקף של אסימוני הגישה יפוג תוך 12 שעות.
  • התוקף של אסימוני הרענון יפוג לאחר 30 יום.

בעקבות זאת, אחרי שמבצעים בהצלחה קריאה ל-API באמצעות acurl או get_token, אפשר להמשיך להשתמש בזוג האסימונים למשך 30 יום. אחרי תאריך התפוגה, יהיה עליך להזין מחדש את פרטי הכניסה שלך ולקבל אסימונים חדשים.

הגדרת נקודת הקצה ל-SSO

לפני שמבצעים את הקריאה הראשונה, צריך להגדיר את נקודת הקצה של שרת ההרשאות לממשק ה-API של Edge שבו רוצים להשתמש עם acurl ועם get_token.

בטרמינל, מגדירים את משתנה הסביבה SSO_LOGIN_URL לנקודת הקצה של שרת ההרשאות. לדוגמה:

  • ללקוחות Cloud בלי תחום (zone): 
    export SSO_LOGIN_URL=https://login.apigee.com
  • ללקוחות Cloud עם תחום מוגדר: 
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • לקוחות של ענן פרטי צריכים לפנות לאדמין כדי לקבל את נקודת הקצה המתאימה ל-SSO.

ניתן להשתמש בקוד סיסמה חד-פעמי (נדרש ל-SAML)

כשמבצעים קריאה ל-API באמצעות acurl או get_token, צריך לאמת את עצמכם בפני כלי השירות כדי לקבל זוג אסימונים. כדי לעשות זאת, צריך להזין את שם המשתמש, הסיסמה וקוד MFA של חשבון Apigee. עם זאת, אם משתמשים ב-IdP של SAML או שלא רוצים להשתמש בסיסמה, אפשר לקבל קוד סיסמה חד-פעמי לשימוש במקום זאת.

כדי לקבל קוד סיסמה חד-פעמי:

  1. מזינים את כתובת ה-URL הבאה בדפדפן:
    • ללקוחות Cloud בלי תחום (zone): 
      https://login.apigee.com/passcode
    • ללקוחות Cloud עם תחום מוגדר: 
      https://zone_name.login.apigee.com/passcode
    • לקוחות של ענן פרטי צריכים לפנות לאדמין כדי לקבל את נקודת הקצה המתאימה ל-SSO.
  2. מתחברים לחשבון Apigee.
  3. מעתיקים את קוד הסיסמה בן 6 התווים.
  4. משתמשים ב-acurl או ב-get_token עם האפשרות -p ומעבירים את קוד הסיסמה, כמו בדוגמה הבאה:
    get_token -p 1a2b3c

הצגת האסימונים

כשמריצים בהצלחה את acurl או את get_token, כלי העזר יוצרים קובץ נתונים ב-~/.sso-cli שמכיל את האסימונים ומטא-נתונים נוספים.

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

get_token -v

הפקודה הזו מציגה את הצהרות הבעלות המפוענחות, לדוגמה:

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) זכויות יוצרים 2023 Google LLC
הכלים acurl ו-get_token זמינים כ "תוכנה" בהתאם להסכם המסדיר את השימוש שלך ב-Google Cloud Platform, כולל התנאים הספציפיים לשירות, הזמינים בכתובת https://cloud.google.com/terms/service-terms.