لمحة عن acurl وget_token

يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات Apigee X.
المعلومات

توفر Apigee الأدوات المساعدة التالية لإنشاء وتمرير رموز الدخول عبر OAuth2 وإعادة التحميل. يمكنك استخدام هذه الرموز المميزة لمصادقة نفسك في طلبات واجهة برمجة تطبيقات Edge باستخدام OAuth (بما في ذلك مهام سير عمل SAML وLDAP):

  • acurl(1): يتم توفير برنامج تضمين مريح حول أمر curl عادي. تنشئ طلبات HTTP إلى واجهة برمجة تطبيقات Edge، وتحصل على رموز الدخول وإعادة التحميل من get_token، وتمرّر رمز الدخول إلى واجهة برمجة تطبيقات Edge.
  • get_token(1): تتبادل بيانات اعتماد Apigee للوصول والرموز المميزة لإعادة التحميل التي يمكنك استخدامها لاستدعاء واجهة برمجة تطبيقات Edge.

تتبادل الأداتان المساعِدتان بيانات اعتماد حسابك على Apigee (اسم المستخدم وكلمة المرور أو رمز المرور) برموز OAuth2 المميزة.

تتوافق الرموز المميزة التي تنشئها أدوات Apigee مع مواصفات إطار عمل تفويض OAuth 2.0.

ويُعدّ استخدام أدوات Apigee المساعدة للحصول على رموز مميّزة أو الوصول إلى خادم المصادقة لواجهات برمجة تطبيقات Edge اختياري. يمكنك تنفيذ مخططاتك الخاصة لإنشاء رموز دخول OAuth2 وإرسالها في طلباتك إلى واجهة برمجة تطبيقات Edge.

تثبيت 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 يومًا.

نتيجةً لذلك، بعد إجراء طلب بيانات من واجهة برمجة التطبيقات بنجاح باستخدام acurl أو get_token، يمكنك مواصلة استخدام الرمز المميّز لمدة 30 يومًا. بعد انتهاء الصلاحية، يجب إعادة إدخال بيانات الاعتماد والحصول على رموز مميّزة جديدة.

ضبط نقطة نهاية خدمة الدخول المُوحَّد (SSO)

قبل إجراء مكالمتك الأولى، يجب ضبط نقطة نهاية خادم التفويض لواجهة برمجة تطبيقات Edge التي تريد استخدامها مع acurl وget_token.

من الوحدة الطرفية، اضبط متغيّر بيئة SSO_LOGIN_URL على نقطة نهاية خادم التفويض. مثال:

  • لعملاء Cloud الذين ليس لديهم منطقة:
    export SSO_LOGIN_URL=https://login.apigee.com
  • لعملاء Google Cloud الذين يستخدمون المنطقة:
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • بالنسبة إلى عملاء Private Cloud، يُرجى التواصل مع المشرف للحصول على نقطة نهاية خدمة الدخول المُوحَّد (SSO) المناسبة.

استخدام رمز مرور لمرة واحدة (مطلوب لتطبيق SAML)

عند إجراء طلب بيانات من واجهة برمجة التطبيقات باستخدام acurl أو get_token، يجب مصادقة نفسك مع الأداة المساعدة لتلقّي زوج من الرموز المميّزة. يمكنك القيام بذلك عن طريق إدخال اسم المستخدم وكلمة المرور لحسابك على Apigee ورمز MFA. ومع ذلك، إذا كنت تستخدم موفّر هوية SAML أو لا تريد استخدام كلمة المرور الخاصة بك، يمكنك الحصول على رمز مرور لمرة واحدة لاستخدامه بدلاً من ذلك.

للحصول على رمز مرور صالح لمرة واحدة:

  1. أدخِل عنوان URL التالي في متصفّح:
    • لعملاء Cloud الذين ليس لديهم منطقة:
      https://login.apigee.com/passcode
    • لعملاء Google Cloud الذين يستخدمون المنطقة:
      https://zone_name.login.apigee.com/passcode
    • بالنسبة إلى عملاء Private 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.