لمحة عن acurl وget_token

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

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

  • acurl(1): توفير برنامج تضمين مريح حول أحد المعايير curl. إنشاء طلبات HTTP إلى Edge تحصل هذه الواجهة من واجهة برمجة التطبيقات، على رموز الدخول وأعد التحميل، من get_token، وتمرر رمز الدخول إلى الحافة واجهة برمجة التطبيقات.
  • 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، يُرجى التواصل مع المشرف للحصول على نقطة نهاية الدخول المُوحَّد (SSO) المناسبة.

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

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

للحصول على رمز مرور صالح لمرة واحدة، يُرجى اتّباع الخطوات التالية:

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