استخدام Get_token

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

تتيح لك الأداة get_token(1) استبدال بيانات اعتماد Apigee برمز الوصول وإعادة التحميل الذي يمكنك استخدامه للوصول إلى واجهات برمجة تطبيقات Edge. يمكن أيضًا استخدام الرموز المميزة مع عمليات تنفيذ SAML وLDAP لسير عمل OAuth2.

يتيح لك تطبيق "get_token" ما يلي:

  • الحصول على رمز الدخول أو إعادة التحميل
  • طباعة الرموز المميّزة في stdout لاستخدامها في المتغيّرات والأوامر
  • تخزين الرموز على القرص

يمكنك بعد ذلك إضافة رمز مميز صالح في طلباتك إلى واجهة برمجة تطبيقات Edge والحصول على رمز مميز جديد عندما تنتهي صلاحية رمزك.

شرط أساسي: قبل أن تتمكّن من استخدام get_token، عليك تثبيته.

بناء جملة get_token

تستخدم الأداة get_token البنية التالية:

get_token -u USERNAME:PASSWORD [-m MFACODE]

أو

get_token -p passcode

المكان:

عنصر مطلوب؟ الوصف
USERNAME اختيارية. يجب إدخال اسم مستخدم وكلمة مرور أو رمز مرور. اسم مستخدم Apigee، والذي يكون عادةً عنوان البريد الإلكتروني المرتبط بحسابك على Apigee. يجب إدخال اسم المستخدم أو رمز المرور في أول مرة تتصل فيها بـ get_token. ولن تحتاج إلى إدخال عنوان بريدك الإلكتروني مرة أخرى إلى أن تنتهي صلاحية رمزَي الدخول وإعادة التحميل. إذا كنت تريد تخزين الرموز المميّزة مؤقتًا لأكثر من مستخدم واحد، عليك تحديد اسم المستخدم الخاص بك في كل طلب.
PASSWORD اختيارية. يجب إدخال اسم مستخدم وكلمة مرور أو رمز مرور. كلمة المرور لحسابك على Apigee إذا حذفت كلمة المرور، سيُطلب منك إدخالها في المرة الأولى التي تستخدم فيها get_token وفي أي مكالمات لاحقة بدون رمز مميّز صالح لإعادة التحميل. إذا كنت لا تريد استخدام كلمة المرور مباشرةً في الأمر، يمكنك استخدام رمز مرور صالح لمرة واحدة بدلاً من كلمة المرور.
MFACODE اختياريّ رمز المصادقة المتعدّدة العوامل (MFA) مؤقت مكوَّن من ستة أرقام. يجب إدخال هذا الرمز في حال استخدام -u وتفعيل ميزة MFA. سيُطلب منك إذا تم حذف المحتوى (إلا في حال استخدام وضع رمز المرور). إذا لم تكن ميزة "MFA" مفعَّلة، أو إذا كان لديك مسار مكتوب، يمكنك تحديد -m "" لتجنُّب الطلبات.
PASSCODE اختيارية. يجب إدخال اسم مستخدم وكلمة مرور أو رمز مرور. رمز مرور صالح لمرة واحدة يمكنك استخدامه بدلاً من كلمة المرور. يجب توفّر رمز مرور عند المصادقة باستخدام موفِّر هوية (IdP) SAML، ويمكن استخدامه للمصادقة باستخدام موفِّر هوية (IdP) LDAP.

مثلاً:

get_token
get_token -u ahamilton@apigee.com:mypassw0rd -m 424242
get_token -p mypass

تؤدي المكالمة الناجحة إلى طباعة رمز دخول صالح إلى stdout وتخزِّن كل من رمزي الدخول وإعادة التحميل في ~/.sso-cli. يمكنك استخدام هذه الرموز المميّزة إلى أن تنتهي صلاحيتها، كما هو موضّح في المقالة انتهاء صلاحية الرمز المميّز.

بعد أول مكالمة ناجحة لك مع الرقم get_token، لن تحتاج إلى تضمين بيانات اعتمادك حتى تنتهي صلاحية الرموز المميّزة.

الاتصال بـ get_token لأول مرة

إذا لم تحدد أي خيارات في مكالمتك الأولى، سيطلب منك get_token تنفيذ ما يلي:

  • رمز مرور في حال المصادقة باستخدام موفِّر هوية SAML (IdP).
  • اسم المستخدم وكلمة المرور ورمز MFA المؤقت أو غير ذلك

يستدعي المثال التالي get_token للمرة الأولى ويستخدم تركيبة اسم المستخدم/كلمة المرور مع رمز MFA اختياري للمصادقة:

get_token
Enter username:
ahamilton@apigee.com
Enter the password for user 'ahamilton@apigee.com':
[hidden input]
Enter the six-digit code if 'ahamilton@apigee.com' is MFA-enabled or press ENTER:
123456

ey42bGciOiJSUzI1NiJ9.eyJqdGkiOiJhM2YwNjA5ZC1lZTIxLTQ1YjAtOGQyMi04MTQ0MTYxNjNhNTMiLCJzdWIiOiIyZDFl
  <snip>
VlLmNvbSIsInppZCI6InVhYSIsImF1ZCI6WyJlZGdlY2xpIiwic2NpbSIsIm9wZW5pZCIsInBhc3N3b3JkIiwiYXBwcm54242

إضافة رمز الدخول إلى أحد الطلبات

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

  • انسخ محتوى استجابة get_token وأدرِجه مباشرةً في العنوان: 
    curl https://api.enterprise.apigee.com/v1/organizations/danger4242-eval \
  -H "Authorization: Bearer B42CnTIYPxr...88NI5Q"
  • ادمِج الأوامر للحصول على الرمز المميّز وإضافته إلى العنوان: 
    token=$(get_token); curl -H "Authorization: Bearer $token" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    يُرجى العِلم أنّ get_token تستخدم بنية استبدال الأوامر $(...) بحيث يتم تنفيذها.

  • الاتصال بـ get_token ضمن مكالمة curl: 
    curl -H "Authorization: Bearer $(get_token)" \
  https://api.enterprise.apigee.com/v1/organizations/ahamilton-eval

    يُرجى العِلم أنّ get_token تستخدم بنية استبدال الأوامر $(...) بحيث يتم تنفيذها.

تحصل الطلبات النموذجية هذه على تفاصيل حول مؤسسة "ahamilton-eval". للحصول على قائمة كاملة بنقاط نهاية واجهة برمجة تطبيقات Edge، يُرجى الاطّلاع على مرجع واجهة برمجة التطبيقات Apigee Edge.

استخدام get_token مع SAML وLDAP

يمكن استخدام الأداة get_token مع SAML أو LDAP أو أي موفِّر هوية (idP) أساسي آخر. يتيح get_token استخدام عناوين URL متعددة لتسجيل الدخول المُوحَّد (SSO) وحسابات متعددة. سيُطلب من مستخدم واحد لديه حسابات متعددة تحديد اسم المستخدم لكل مكالمة get_token.

محو ذاكرة التخزين المؤقت get_token

يمكنك استخدام العلامات الاختيارية التالية لمحو ذاكرة التخزين المؤقت لـ get_token:

  • --clear-sso-cache

    يمحو دليل ذاكرة التخزين المؤقت لـ SSO_LOGIN_URL ضمن $HOME/.sso-cli مع تجاهل أي رموز مميزة للدخول المخزّنة مؤقتًا وإعادة التحميل للخادم.

  • --clear-all-sso-cache

    يؤدي ذلك إلى محو جميع الأدلة ضمن $HOME/.sso-cli مع تجاهل جميع الرموز المميّزة المخزَّنة مؤقتًا.

(1) حقوق الطبع والنشر لعام 2023 لشركة Google LLC
يتم توفير أداة get_token بصفتها "برامج" بموجب الاتفاقية التي تحكم استخدامك لخدمة Google Cloud Platform، بما في ذلك البنود الخاصة بالخدمة المتوفّرة على https://cloud.google.com/terms/service-terms.