برمجة عملية إنشاء الرمز المميّز

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

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

ومع ذلك، قد تدعم بيئتك التشغيل الآلي لمهام التطوير الشائعة، مثل اختبار التشغيل الآلي أو الدمج المستمر أو النشر المستمر (CI/CD). للتشغيل الآلي هذه المهام عند تفعيل SAML، ستحتاج إلى طريقة للحصول على رموز OAuth2 المميزة وإعادة تحميلها بدون الاضطرار إلى نسخ/لصق رمز المرور من المتصفح.

لمحة عن مستخدمي الأجهزة

يتوافق Apigee Edge مع مستخدمي الأجهزة في مؤسستك التي تم تفعيل SAML فيها. يتم استخدام مستخدمي الأجهزة بشكل صارم في عمليات التشغيل الآلي ولا يمكن لشخص الوصول إليها مباشرةً.

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

خطوات إنشاء الرموز المميّزة بشكل آلي

لبرمجة عملية إنشاء الرموز المميّزة، يجب اتّباع الخطوات التالية:

الخطوة الوصف
1 إنشاء مستخدم جهاز في منطقة هوية SAML
2 إسناد الأدوار المطلوبة لمستخدم الجهاز في مؤسسة Edge
3 الحصول على رموز OAuth2 المميزة لمستخدمي الأجهزة

فيديو: يمكنك مشاهدة فيديو قصير للتعرّف على طريقة الوصول التلقائي إلى واجهات برمجة تطبيقات Apigee Edge باستخدام بيانات اعتماد مستخدم الجهاز.

إدارة مستخدمي الأجهزة في مناطق هوية SAML

توفّر Apigee واجهة سطر أوامر إدارة مستخدمي الأجهزة (CLI) لإنشاء حسابات مستخدمي الجهاز وإدارتها. يتم توضيح خطوات استخدام واجهة سطر الأوامر لإدارة مستخدم الجهاز في الأقسام التالية.

استخدام واجهة سطر الأوامر

لاستخدام واجهة سطر الأوامر لإدارة مستخدمي الجهاز، عليك أولاً تنزيل الملف التالي وفكه: usermgmt.tar.gz(1)

يكون تنسيق استدعاء واجهة سطر الأوامر كما يلي:

usermgmt_platform [command] [flags]

يلخّص الجدول التالي الأنظمة الأساسية المتاحة والأمر المقابل لاستدعاء واجهة سطر الأوامر لإدارة مستخدمي الجهاز. (يمكن العثور على الملفات التنفيذية في دليل usermgmt.)

النظام الأساسي 32 بت 64 بت
Linux usermgmt_linux_386 usermgmt_linux_amd64
نظام التشغيل Mac usermgmt_darwin_386 usermgmt_darwin_amd64
Windows usermgmt_windows_386 usermgmt_windows_amd64

يلخّص الجدول التالي الأوامر التي يمكن تحديدها.

Command مزيد من المعلومات
create إنشاء مستخدم جهاز في منطقة تحديد هوية
delete حذف مستخدم جهاز في منطقة تحديد هوية
help الحصول على مساعدة في استخدام واجهة سطر الأوامر
list سرد جميع مستخدمي الأجهزة في منطقة هوية
reset إعادة ضبط كلمة المرور لمستخدم جهاز في منطقة تحديد هوية

يمكنك اختياريًا تمرير إحدى العلامات التالية لعرض المساعدة في الأمر المحدّد: -h أو --help.

تسجيل الدخول إلى واجهة سطر الأوامر

في المرة الأولى التي تُشغِّل فيها واجهة سطر الأوامر (CLI) خلال 24 ساعة، سيُطلب منك إدخال بيانات اعتماد حسابك في zoneadmin.

Enter your Apigee credentials
Username: zoneadmin-username
Password: zoneadmin-password
If your user is opted with MFA, enter MFA code. Otherwise press enter to skip.
MFA: mfa-code_or_enter_to_skip

يخزِّن واجهة سطر الأوامر لإدارة مستخدمي الجهاز رمز دخول على جهازك المحلي، لذا لن تضطر إلى تسجيل الدخول سوى مرة واحدة كل 24 ساعة.

الحصول على مساعدة في استخدام واجهة سطر الأوامر

عرض معلومات استخدام واجهة سطر الأوامر باستخدام أمر usermgmt_platform help يمكنك مراجعة استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتاحة.

usermgmt_platform help

يتم عرض معلومات المساعدة التالية:

A command-line interface (CLI) to manage machine user accounts to automate
Apigee identity zone management. Use the CLI to create, list, delete,
and reset the password for machine users.

Usage:
  usermgmt [flags]
  usermgmt [command]

Available Commands:
  create  Creates a machine users in an identity zone.
  delete  Deletes a machine users in an identity zone.
  help    Help about any command
  list    Lists the machine users in an identity zone.
  reset   Resets the password for a machine user in an identity zone.

Flags:
  -h, --help               help for usermgmt

Use "usermgmt [command] --help" for more information about a command.

يمكنك عرض مساعدة على أمر محدد من خلال إدخال كل من الأمر -h أو --help في سطر الأوامر.

على سبيل المثال، للحصول على مساعدة بشأن الأمر list:

usermgmt_platform list -h

يتم عرض معلومات المساعدة التالية:

Lists the machine users in an identity zone.

Usage:
  usermgmt list [flags]

Flags:
  -h, --help   help for list

إنشاء مستخدم جهاز في منطقة تحديد هوية

يمكنك إنشاء مستخدم جهاز في منطقة تحديد هوية باستخدام الأمر usermgmt_platform create. يمكنك مراجعة استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتاحة.

  1. أدخِل الأمر التالي: 
    usermgmt_platform create

    يتم عرض قائمة مناطق الهوية:

    myzone1
myzone2
  2. أدخِل اسم المنطقة في الطلب: 
    Enter a zone name: myzone1
  3. يُرجى إدخال اسم مستخدم لمستخدم الجهاز: 
    Create a Machine User
Username: machineuser1@mycompany.com
  4. أدخِل كلمة مرور لمستخدم الجهاز. أعِد إدخال كلمة المرور عندما يُطلب منك ذلك. 
    Password: password
Re-enter password: password

    يتم إنشاء المستخدم.

    Created machine user machineuser1@mycompany.com

سرد جميع مستخدمي الأجهزة في منطقة هوية

أدرِج جميع مستخدمي الأجهزة في منطقة هوية باستخدام الأمر usermgmt_platform list. يمكنك مراجعة استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتاحة.

  1. أدخِل الأمر التالي: 
    usermgmt_platform list
    يتم عرض قائمة مناطق الهوية: 
    myzone1
myzone2
  2. أدخِل اسم المنطقة في الطلب: 
    Enter a zone name: myzone1

    يتم عرض قائمة مستخدمي الأجهزة في منطقة الهوية:

    Machine users in the zone:
machineuser1@mycompany.com

إعادة ضبط كلمة المرور لمستخدم جهاز في منطقة تحديد هوية

يمكنك إعادة ضبط كلمة المرور لمستخدم جهاز في منطقة هوية باستخدام الأمر usermgmt_platform إعادة الضبط. يمكنك مراجعة استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتاحة.

  1. أدخِل الأمر التالي: 
    usermgmt_platform reset

    يتم عرض قائمة مناطق الهوية:

    myzone1
myzone2
  2. أدخِل اسم المنطقة في الطلب: 
    Enter a zone name: myzone1
  3. أدخِل اسم المستخدم لمستخدم الجهاز الذي تريد إعادة ضبط كلمة المرور له: 
    Reset User Password
Enter the username for the machine user
Username: machineuser1@mycompany.com
  4. أدخِل كلمة مرور جديدة لمستخدم الجهاز. أعِد إدخال كلمة المرور عندما يُطلب منك ذلك. 
    Enter the new password: password
Re-enter password: password

    وتتم إعادة ضبط كلمة المرور.

    Reset password for machine user machineuser1@mycompany.com

حذف مستخدم جهاز في منطقة تحديد هوية

احذف حساب مستخدم جهاز في منطقة تحديد هوية باستخدام الأمر usermgmt_platform delete. يمكنك مراجعة استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتاحة.

  1. أدخِل الأمر التالي: 
    usermgmt_platform delete
    يتم عرض قائمة مناطق الهوية: 
    myzone1
myzone2
  2. أدخِل اسم المنطقة في الطلب: 
    Enter a zone name: myzone1
  3. أدخِل اسم المستخدم لمستخدم الجهاز الذي تريد حذفه: 
    Delete User
Enter the username for the machine user
Username: machineuser1@mycompany.com

    تم حذف مستخدم الجهاز.

    Deleted user machineuser1@mycompany.com

تعيين الأدوار المطلوبة لمستخدم الجهاز في مؤسستك على Edge

باستخدام واجهة المستخدم، أضِف مستخدم الجهاز إلى مؤسسة Edge المفعَّلة باستخدام SAML وخصِّص الأدوار المطلوبة (مثل مشرف المؤسسة) له. كما هو موضَّح في إضافة مستخدمين.

الحصول على رموز OAuth2 المميزة لمستخدم الجهاز

يمكنك برمجة عملية إنشاء الرموز المميّزة والتعامل مع التخزين المؤقت للرموز المميّزة لمستخدمي الأجهزة من خلال برامج الخدمات acurl(1) وget_token(1) كما هو موضَّح في OAuth2 لمستخدمي الأجهزة ومستخدمي الأجهزة في مناطق SAML.

للحصول على رموز OAuth2 المميزة لمستخدم الجهاز يدويًا باستخدام curl:

  1. استخدِم أداة ترميز عناوين URL المفضّلة لديك لترميز اسم المستخدم وكلمة المرور لمستخدم الجهاز.

    تحذير: يمكنك استخدام أداة ترميز داخلية لترميز عناوين URL للتأكّد من أنه لن يتم اختراق بيانات اعتماد مستخدم الجهاز.

  2. يمكنك إنشاء رموز الدخول الأولية وإعادة التحميل من خلال طلب نقطة نهاية رمز SAML المميز، كما هو موضح في المثال التالي: 
    curl -H "Content-Type: application/x-www-form-urlencoded;charset=utf-8" \
  -H "accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
  https://zoneName.login.apigee.com/oauth/token -s \
  -d 'grant_type=password&username=machineusername&password=machineuserpassword'

    للحصول على التفويض، يُرجى تمرير بيانات اعتماد عميل OAuth2 المحجوزة، ZWRnZWNsaTplZGdlY2xpc2VjcmV0، في عنوان Authorization تطبع المكالمة رموز الدخول والتحديث إلى stdout

  3. تمرير رمز الدخول إلى استدعاء واجهة برمجة تطبيقات إدارة Edge باعتباره عنوان Bearer: 
    curl -H "Authorization: Bearer ACCESS_TOKEN" \
  https://api.enterprise.apigee.com/v1/organizations/orgName
  4. عند انتهاء صلاحية رمز الدخول، يمكنك إعادة تحميله عن طريق إرسال الرمز المميز لإعادة التحميل إلى SAML نقطة نهاية الرمز المميز، كما يبيِّن المثال التالي: 
    curl -H "Content-Type:application/x-www-form-urlencoded;charset=utf-8" \
  -H "Accept: application/json;charset=utf-8" \
  -H "Authorization: Basic ZWRnZWNsaTplZGdlY2xpc2VjcmV0" -X POST \
  https://zoneName.login.apigee.com/oauth/token \
  -d 'grant_type=refresh_token&refresh_token=REFRESH_TOKEN'

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