لمحة عن acurl وget_token

أنت الآن بصدد الاطّلاع على مستندات Apigee Edge.
انتقِل إلىمستندات Apigee X.
info

توفر 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
  • بالنسبة إلى عملاء Cloud مع منطقة:
    export SSO_LOGIN_URL=https://zone_name.login.apigee.com
  • بالنسبة إلى عملاء Private Cloud، يُرجى التواصل مع المشرف للحصول على نقطة نهاية الدخول المُوحَّد المناسبة.

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

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

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

  1. أدخِل عنوان URL التالي في أحد المتصفحات:
    • بالنسبة إلى عملاء Cloud بدون منطقة:
      https://login.apigee.com/passcode
    • بالنسبة إلى عملاء Cloud مع منطقة:
      https://zone_name.login.apigee.com/passcode
    • بالنسبة إلى عملاء Private Cloud، يُرجى التواصل مع المشرف للحصول على نقطة نهاية الدخول المُوحَّد المناسبة.
  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) حقوق الطبع والنشر محفوظة لشركة Google LLC لعام 2023
تتوفّر الأداتان acurl وget_token كـ "برامج" بموجب الاتفاقية التي تحكم استخدامك لمنصة Google Cloud Platform، بما في ذلك بنود الخدمة الخاصة المتوفّرة على https://cloud.google.com/terms/service-terms.