Admin SDK: Directory API

تتيح Admin SDK Directory API لمشرفي نطاقات المؤسسات الاطّلاع على المستخدمين والمجموعات والأجهزة والموارد ذات الصلة في مؤسستهم وإدارتها. توفّر واجهات برمجة تطبيقات Cloud Identity طرقًا إضافية لإدارة بعض الموارد نفسها.

الخدمة: admin.googleapis.com

للاتّصال بهذه الخدمة، ننصحك باستخدام مكتبات العملاء التي تقدّمها Google. إذا كان تطبيقك بحاجة إلى استخدام مكتباتك الخاصة للاتصال بهذه الخدمة، استخدِم المعلومات التالية عند إجراء طلبات واجهة برمجة التطبيقات.

المستند المرتبط بميزة "اقتراحات"

مستند الاكتشاف هو مواصفة قابلة للقراءة آليًا لوصف واجهات برمجة التطبيقات REST واستخدامها. ويتم استخدامه لإنشاء مكتبات العملاء ومكونات إضافية لبيئة تطوير البرامج المتكاملة وأدوات أخرى تتفاعل مع واجهات برمجة تطبيقات Google. قد توفّر خدمة واحدة عدة مستندات اكتشاف. توفّر هذه الخدمة مستند الاكتشاف التالي:

نقطة نهاية الخدمة

نقطة نهاية الخدمة هي عنوان URL أساسي يحدِّد عنوان الشبكة لخدمة واجهة برمجة التطبيقات. قد تتضمّن خدمة واحدة عدة نقاط نهاية للخدمات. تحتوي هذه الخدمة على نقطة نهاية الخدمة التالية، وترتبط كل معرّفات الموارد المنتظمة (URI) أدناه بنقطة نهاية الخدمة هذه:

  • https://admin.googleapis.com

مورد REST: ‏ asps

الطُرق
delete DELETE /admin/directory/v1/users/{userKey}/asps/{codeId}
لحذف شهادة ASP أصدرَها مستخدم
get GET /admin/directory/v1/users/{userKey}/asps/{codeId}
للحصول على معلومات عن شهادة ASP أصدرَها مستخدم
list GET /admin/directory/v1/users/{userKey}/asps
تعرض هذه السمة شهادات ASP التي أصدرَها مستخدم.

مورد REST: ‏ chromeosdevices

الطُرق
action
(deprecated)		 POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{resourceId}/action
استخدِم BatchChangeChromeOsDeviceStatus بدلاً منه.
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
يسترجع خصائص جهاز ChromeOS.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
يستردّ هذه الدالة قائمة مفصّلة بأجهزة ChromeOS ضمن حساب معيّن.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
تنقل هذه الميزة أجهزة ChromeOS متعددة أو تُدرجها في وحدة تنظيمية.
patch PATCH /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
لتعديل خصائص الجهاز القابلة للتعديل، مثل annotatedUser أو annotatedLocation أو notes أو orgUnitPath أو annotatedAssetId.
update PUT /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}
لتعديل خصائص الجهاز القابلة للتعديل، مثل annotatedUser أو annotatedLocation أو notes أو orgUnitPath أو annotatedAssetId.

مورد REST: ‏ customer.devices.chromeos

الطُرق
batchChangeStatus POST /admin/directory/v1/customer/{customerId}/devices/chromeos:batchChangeStatus
لتغيير حالة مجموعة من أجهزة ChromeOS
issueCommand POST /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}:issueCommand
يُصدر الأمر للجهاز لتنفيذه.

مورد REST: ‏ customer.devices.chromeos.commands

الطُرق
get GET /admin/directory/v1/customer/{customerId}/devices/chromeos/{deviceId}/commands/{commandId}
تحصل على بيانات الأمر، وهو أمر محدّد تم إصداره للجهاز.

مورد REST: ‏ customers

الطُرق
get GET /admin/directory/v1/customers/{customerKey}
لاسترداد عميل.
patch PATCH /admin/directory/v1/customers/{customerKey}
تصحيح عميل
update PUT /admin/directory/v1/customers/{customerKey}
تعديل بيانات عميل

مورد REST: ‏ domainAliases

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
يؤدي هذا الإجراء إلى حذف اسم نطاق بديل للعميل.
get GET /admin/directory/v1/customer/{customer}/domainaliases/{domainAliasName}
يسترجع اسم نطاق بديلاً للعميل.
insert POST /admin/directory/v1/customer/{customer}/domainaliases
تُستخدَم هذه السمة لإدراج اسم نطاق بديل للعميل.
list GET /admin/directory/v1/customer/{customer}/domainaliases
تعرض هذه السمة الأسماء المستعارة للنطاقات الخاصة بالعميل.

مورد REST: ‏ domains

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/domains/{domainName}
يؤدي هذا الإجراء إلى حذف نطاق العميل.
get GET /admin/directory/v1/customer/{customer}/domains/{domainName}
يسترجع نطاقًا للعميل.
insert POST /admin/directory/v1/customer/{customer}/domains
تُستخدَم هذه السمة لإدراج نطاق العميل.
list GET /admin/directory/v1/customer/{customer}/domains
تعرض هذه السمة نطاقات العميل.

مورد REST: ‏ groups

الطُرق
delete DELETE /admin/directory/v1/groups/{groupKey}
لحذف مجموعة
get GET /admin/directory/v1/groups/{groupKey}
تستردّ خصائص المجموعة.
insert POST /admin/directory/v1/groups
لإنشاء مجموعة.
list GET /admin/directory/v1/groups
يسترجع جميع مجموعات نطاق أو مستخدم معيّن باستخدام مفتاح مستخدم (مقسّمة إلى صفحات).
patch PATCH /admin/directory/v1/groups/{groupKey}
لتعديل خصائص مجموعة
update PUT /admin/directory/v1/groups/{groupKey}
لتعديل خصائص مجموعة

مورد REST: ‏ groups.aliases

الطُرق
delete DELETE /admin/directory/v1/groups/{groupKey}/aliases/{alias}
تزيل اسمًا بديلاً.
insert POST /admin/directory/v1/groups/{groupKey}/aliases
تُضيف اسمًا بديلاً للمجموعة.
list GET /admin/directory/v1/groups/{groupKey}/aliases
يسرد جميع العناوين البديلة لمجموعة.

مورد REST: ‏ members

الطُرق
delete DELETE /admin/directory/v1/groups/{groupKey}/members/{memberKey}
تؤدي هذه الخطوة إلى إزالة عضو من مجموعة.
get GET /admin/directory/v1/groups/{groupKey}/members/{memberKey}
يستردّ سمات عضو المجموعة.
hasMember GET /admin/directory/v1/groups/{groupKey}/hasMember/{memberKey}
للتحقّق مما إذا كان المستخدم المحدّد عضوًا في المجموعة.
insert POST /admin/directory/v1/groups/{groupKey}/members
تُضيف هذه الوظيفة مستخدمًا إلى المجموعة المحدّدة.
list GET /admin/directory/v1/groups/{groupKey}/members
يسترجع هذه الدالة قائمة مفصّلة بجميع الأعضاء في مجموعة.
patch PATCH /admin/directory/v1/groups/{groupKey}/members/{memberKey}
لتعديل خصائص العضوية لمستخدم في المجموعة المحدّدة.
update PUT /admin/directory/v1/groups/{groupKey}/members/{memberKey}
لتعديل عضوية مستخدم في المجموعة المحدّدة.

مورد REST: ‏ mobiledevices

الطُرق
action POST /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}/action
يتّخذ إجراءً يؤثر في جهاز جوّال.
delete DELETE /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
تؤدي هذه العملية إلى إزالة جهاز جوّال.
get GET /admin/directory/v1/customer/{customerId}/devices/mobile/{resourceId}
تستردّ هذه السمة سمات جهاز جوّال.
list GET /admin/directory/v1/customer/{customerId}/devices/mobile
يستردّ هذا الطلب قائمة مفصّلة بجميع الأجهزة الجوّالة التي يملكها المستخدمون لحساب معيّن.

مورد REST: ‏ orgunits

الطُرق
delete DELETE /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
تزيل وحدة تنظيمية.
get GET /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
يسترجع وحدة تنظيمية.
insert POST /admin/directory/v1/customer/{customerId}/orgunits
تُستخدَم لإضافة وحدة تنظيمية.
list GET /admin/directory/v1/customer/{customerId}/orgunits
يسترجع قائمة بجميع الوحدات التنظيمية لحساب معيّن.
patch PATCH /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
لتعديل وحدة تنظيمية.
update PUT /admin/directory/v1/customer/{customerId}/orgunits/{orgUnitPath=**}
لتعديل وحدة تنظيمية.

مورد REST: ‏ privileges

الطُرق
list GET /admin/directory/v1/customer/{customer}/roles/ALL/privileges
يسترجع هذه الوظيفة قائمة مفصّلة بجميع الامتيازات للعميل.

مورد REST: ‏ resources.buildings

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
لحذف مبنى.
get GET /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
لاسترداد مبنى.
insert POST /admin/directory/v1/customer/{customer}/resources/buildings
لإدراج مبنى.
list GET /admin/directory/v1/customer/{customer}/resources/buildings
يسترجع هذه الوظيفة قائمة بالمباني لحساب معيّن.
patch PATCH /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
يُصلح المبنى.
update PUT /admin/directory/v1/customer/{customer}/resources/buildings/{buildingId}
تعديل مبنى

مورد REST: ‏ resources.calendars

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
لحذف مورد تقويم.
get GET /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
يسترجع مورد تقويم.
insert POST /admin/directory/v1/customer/{customer}/resources/calendars
تُستخدَم لإدراج مورد تقويم.
list GET /admin/directory/v1/customer/{customer}/resources/calendars
يسترجع قائمة بموارد التقويم لحساب معيّن.
patch PATCH /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
تُعدِّل هذه السمة مورد تقويم.
update PUT /admin/directory/v1/customer/{customer}/resources/calendars/{calendarResourceId}
لتعديل مورد تقويم.

مورد REST: ‏ resources.features

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
يؤدي هذا الإجراء إلى حذف ميزة.
get GET /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
يسترجع ميزة.
insert POST /admin/directory/v1/customer/{customer}/resources/features
لإدراج ميزة
list GET /admin/directory/v1/customer/{customer}/resources/features
يسترجع قائمة بالميزات لحساب معيّن.
patch PATCH /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
تصحيح ميزة
rename POST /admin/directory/v1/customer/{customer}/resources/features/{oldName}/rename
لإعادة تسمية ميزة.
update PUT /admin/directory/v1/customer/{customer}/resources/features/{featureKey}
تعديل ميزة

مورد REST: ‏ roleAssignments

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
لحذف تعيين دور
get GET /admin/directory/v1/customer/{customer}/roleassignments/{roleAssignmentId}
لاسترداد تعيين دور
insert POST /admin/directory/v1/customer/{customer}/roleassignments
لإنشاء عملية منح دور
list GET /admin/directory/v1/customer/{customer}/roleassignments
يسترجع هذه الدالة قائمة مفصّلة بجميع عمليات منح الأدوار.

مورد REST: ‏ roles

الطُرق
delete DELETE /admin/directory/v1/customer/{customer}/roles/{roleId}
لحذف دور.
get GET /admin/directory/v1/customer/{customer}/roles/{roleId}
يسترجع دورًا.
insert POST /admin/directory/v1/customer/{customer}/roles
لإنشاء دور.
list GET /admin/directory/v1/customer/{customer}/roles
يسترجع هذه الوظيفة قائمة مفصّلة بجميع الأدوار في نطاق معيّن.
patch PATCH /admin/directory/v1/customer/{customer}/roles/{roleId}
تصحيح دور
update PUT /admin/directory/v1/customer/{customer}/roles/{roleId}
تعديل دور

مورد REST: ‏ schemas

الطُرق
delete DELETE /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
لحذف مخطّط
get GET /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
لاسترداد مخطّط
insert POST /admin/directory/v1/customer/{customerId}/schemas
لإنشاء مخطّط
list GET /admin/directory/v1/customer/{customerId}/schemas
يسترجع جميع المخططات للعميل.
patch PATCH /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
تُعدِّل هذه الدالة مخطّطًا.
update PUT /admin/directory/v1/customer/{customerId}/schemas/{schemaKey}
لتعديل مخطّط

مورد REST: ‏ tokens

الطُرق
delete DELETE /admin/directory/v1/users/{userKey}/tokens/{clientId}
يؤدي هذا الإجراء إلى حذف جميع رموز الوصول التي أصدرها مستخدم لتطبيق معيّن.
get GET /admin/directory/v1/users/{userKey}/tokens/{clientId}
للحصول على معلومات عن رمز دخول صادر عن مستخدم
list GET /admin/directory/v1/users/{userKey}/tokens
تعرِض هذه الدالة مجموعة الرموز المميّزة التي أصدرها المستخدم المحدّد للتطبيقات التابعة لجهات خارجية.

مورد REST: ‏ twoStepVerification

الطُرق
turnOff POST /admin/directory/v1/users/{userKey}/twoStepVerification/turnOff
يؤدي ذلك إلى إيقاف ميزة "التحقّق بخطوتين" للمستخدم.

مورد REST: ‏ users

الطُرق
delete DELETE /admin/directory/v1/users/{userKey}
لحذف مستخدم.
get GET /admin/directory/v1/users/{userKey}
يسترجع مستخدمًا.
insert POST /admin/directory/v1/users
لإنشاء مستخدم.
list GET /admin/directory/v1/users
يستردّ هذه الدالة قائمة مفصّلة بالمستخدمين المحذوفين أو جميع المستخدمين في نطاق معيّن.
makeAdmin POST /admin/directory/v1/users/{userKey}/makeAdmin
يمنح المستخدم دور المشرف المتميّز.
patch PATCH /admin/directory/v1/users/{userKey}
تعديل بيانات مستخدم باستخدام دلالات رموز التصحيح
signOut POST /admin/directory/v1/users/{userKey}/signOut
تؤدي هذه العملية إلى تسجيل خروج المستخدم من جميع جلسات الويب والأجهزة وإعادة ضبط ملفات تعريف ارتباط تسجيل الدخول.
undelete POST /admin/directory/v1/users/{userKey}/undelete
لإعادة عرض مستخدم تم حذفه.
update PUT /admin/directory/v1/users/{userKey}
تعديل بيانات مستخدم
watch POST /admin/directory/v1/users/watch
يتتبّع التغييرات في قائمة المستخدمين.

مورد REST: ‏ users.aliases

الطُرق
delete DELETE /admin/directory/v1/users/{userKey}/aliases/{alias}
تزيل اسمًا بديلاً.
insert POST /admin/directory/v1/users/{userKey}/aliases
تُستخدَم لإضافة عنوان بديل.
list GET /admin/directory/v1/users/{userKey}/aliases
تعرض هذه السمة جميع العناوين البديلة لمستخدم معيّن.
watch POST /admin/directory/v1/users/{userKey}/aliases/watch
يتتبّع التغييرات في قائمة المستخدمين.

مورد REST: ‏ users.photos

الطُرق
delete DELETE /admin/directory/v1/users/{userKey}/photos/thumbnail
تؤدي هذه العملية إلى إزالة صورة المستخدم.
get GET /admin/directory/v1/users/{userKey}/photos/thumbnail
لاسترداد صورة المستخدم.
patch PATCH /admin/directory/v1/users/{userKey}/photos/thumbnail
لإضافة صورة للمستخدم
update PUT /admin/directory/v1/users/{userKey}/photos/thumbnail
لإضافة صورة للمستخدم

مورد REST: ‏ verificationCodes

الطُرق
generate POST /admin/directory/v1/users/{userKey}/verificationCodes/generate
لإنشاء رموز تحقق احتياطية جديدة للمستخدم.
invalidate POST /admin/directory/v1/users/{userKey}/verificationCodes/invalidate
يؤدي ذلك إلى إبطال رموز التحقّق الاحتياطية الحالية للمستخدم.
list GET /admin/directory/v1/users/{userKey}/verificationCodes
تعرِض هذه الدالة المجموعة الحالية من رموز التحقّق الاحتياطية الصالحة للمستخدم المحدّد.