מידע על acurl ו-get_token

מוצג המסמך של Apigee Edge.
עוברים אל מסמכי תיעוד של Apigee X. מידע

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

  • acurl(1): מספק wrapper נוחות סביב תקן הפקודה curl. בניית בקשות HTTP ל-Edge API, מקבל אסימוני גישה ורענון מ-get_token, ומעביר את אסימון הגישה אל הקצה API.
  • 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

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

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

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

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

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

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

  1. מזינים את כתובת ה-URL הבאה בדפדפן:
    • ללקוחות Cloud ללא תחום: 
      https://login.apigee.com/passcode
    • ללקוחות Cloud עם תחום: 
      https://zone_name.login.apigee.com/passcode
    • ללקוחות של 'Cloud פרטי' צריך לפנות לאדמין של נקודת הקצה המתאימה ל-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.