يتم الآن عرض مستندات Apigee Edge.
انتقِل إلى مستندات
Apigee X. المعلومات
عند استخدام SAML مع واجهة برمجة تطبيقات Edge، يُطلق على العملية التي تستخدمها للحصول على رموز الدخول عبر OAuth2 وإعادة التحميل من تأكيد SAML اسم مسار رمز المرور. من خلال مسار رمز المرور، يمكنك استخدام متصفّح للحصول على رمز مرور لمرة واحدة تستخدمه بعد ذلك للحصول على رموز OAuth2 المميزة.
ومع ذلك، قد تدعم بيئتك التشغيل الآلي لمهام التطوير الشائعة، مثل التشغيل الآلي للاختبار أو التكامل المستمر/النشر المستمر (CI/CD). لتنفيذ هذه المهام آليًا عندما تكون SAML مفعّلة، يجب توفير طريقة للحصول على رموز OAuth2 المميزة وإعادة تحميلها بدون الحاجة إلى نسخ/لصق رمز مرور من متصفّح.
لمحة عن مستخدمي الأجهزة
يتوافق Apigee Edge مع مستخدمي الأجهزة في مؤسستك التي تم تفعيل SAML فيها. يتم استخدام مستخدمي الأجهزة فقط في عمليات التشغيل الآلي ولا يمكن لأي شخص الوصول إليها مباشرةً.
ويمكن لمستخدم الجهاز الحصول على رموز OAuth2 المميزة بدون الحاجة إلى تحديد رمز مرور. وهذا يعني أنّه يمكنك برمجة عملية الحصول على رموز OAuth2 المميزة وإعادة تحميلها باستخدام Edge API.
خطوات برمجة عملية إنشاء الرموز المميّزة
لأتمتة عملية إنشاء الرمز المميز:
الخطوة | الوصف |
---|---|
1 | إنشاء مستخدم جهاز في منطقة هوية SAML |
2 | إسناد الأدوار المطلوبة لمستخدم الجهاز في مؤسسة Edge |
3 | الحصول على رموز OAuth2 المميزة لمستخدمي الجهاز |
فيديو: يمكنك مشاهدة فيديو قصير للتعرّف على كيفية الوصول إلى واجهات برمجة تطبيقات Apigee Edge تلقائيًا باستخدام بيانات اعتماد مستخدم الجهاز.
إدارة مستخدمي الأجهزة لمناطق هوية SAML
توفّر Apigee واجهة سطر أوامر إدارة مستخدمي الأجهزة (CLI) لإنشاء حسابات مستخدمي الأجهزة وإدارتها. في الأقسام التالية، يتم توضيح خطوات استخدام واجهة سطر الأوامر (CLI) لإدارة مستخدمي الأجهزة.
استخدام واجهة سطر الأوامر
لاستخدام واجهة سطر الأوامر (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
يخزِّن واجهة سطر الأوامر (CLI) لإدارة مستخدمي الأجهزة رمز دخول على جهازك المحلي، لذا عليك تسجيل الدخول مرة واحدة فقط كل 24 ساعة.
الحصول على مساعدة في استخدام واجهة سطر الأوامر
اعرض معلومات استخدام واجهة سطر الأوامر (CLI) باستخدام الأمر 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. راجِع استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتوافقة.
- أدخِل الأمر التالي:
usermgmt_platform create
يتم عرض قائمة مناطق الهوية:
myzone1 myzone2
- أدخِل اسم منطقة في الطلب:
Enter a zone name: myzone1
- أدخِل اسم مستخدم لمستخدم الجهاز:
Create a Machine User Username: machineuser1@mycompany.com
- أدخِل كلمة مرور لمستخدم الجهاز. أعِد إدخال كلمة المرور عندما يُطلب منك ذلك.
Password: password Re-enter password: password
تم إنشاء حساب المستخدم.
Created machine user machineuser1@mycompany.com
إدراج جميع مستخدمي الجهاز في منطقة هوية واحدة
أدرج جميع مستخدمي الأجهزة في منطقة هوية باستخدام الأمر usermgmt_platform list. راجِع استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتوافقة.
- أدخِل الأمر التالي:
يتم عرض قائمة مناطق الهوية:usermgmt_platform list
myzone1 myzone2
- أدخِل اسم منطقة في الطلب:
Enter a zone name: myzone1
يتم عرض قائمة مستخدمي الجهاز في منطقة الهوية:
Machine users in the zone: machineuser1@mycompany.com
إعادة ضبط كلمة المرور لمستخدم جهاز في منطقة هوية
يمكنك إعادة ضبط كلمة المرور لمستخدم جهاز في منطقة هوية باستخدام الأمر usermgmt_platformReset. راجِع استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتوافقة.
- أدخِل الأمر التالي:
usermgmt_platform reset
يتم عرض قائمة مناطق الهوية:
myzone1 myzone2
- أدخِل اسم منطقة في الطلب:
Enter a zone name: myzone1
- أدخِل اسم المستخدم لمستخدم الجهاز الذي تريد إعادة ضبط كلمة مروره:
Reset User Password Enter the username for the machine user Username: machineuser1@mycompany.com
- أدخِل كلمة مرور جديدة لمستخدم الجهاز. أعِد إدخال كلمة المرور عندما يُطلب منك ذلك.
Enter the new password: password Re-enter password: password
تتم إعادة ضبط كلمة المرور.
Reset password for machine user machineuser1@mycompany.com
حذف مستخدم جهاز في منطقة هوية
يمكنك حذف مستخدم جهاز في منطقة هوية باستخدام الأمر usermgmt_platform delete. راجِع استخدام واجهة سطر الأوامر للاطّلاع على قائمة بالأنظمة الأساسية المتوافقة.
- أدخِل الأمر التالي:
يتم عرض قائمة مناطق الهوية:usermgmt_platform delete
myzone1 myzone2
- أدخِل اسم منطقة في الطلب:
Enter a zone name: myzone1
- أدخِل اسم المستخدم لمستخدم الجهاز الذي تريد حذفه:
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
:
- استخدِم أداة ترميز عناوين URL المفضّلة لديك لتشفير اسم المستخدم وكلمة المرور لمستخدم الجهاز.
تحذير: استخدِم أداة ترميز عناوين URL
داخلية لضمان عدم اختراق بيانات اعتماد مستخدم الجهاز. - يمكنك إنشاء الرموز المميزة للوصول الأولي وإعادة التحميل عن طريق استدعاء نقطة نهاية رمز 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
. - مرِّر رمز الدخول إلى طلب بيانات من واجهة برمجة تطبيقات إدارة Edge على أنّه عنوان الحامل:
curl -H "Authorization: Bearer ACCESS_TOKEN" \ https://api.enterprise.apigee.com/v1/organizations/orgName
- عند انتهاء صلاحية رمز الدخول، يمكنك إعادة تحميله من خلال إرسال الرمز المميّز لإعادة التحميل إلى نقطة نهاية رمز 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.