Admin SDK: Directory API

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

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

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

مستند "اقتراحات"

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

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

نقطة نهاية الخدمة هي عنوان 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}
يسترد هذا الإعداد خصائص جهاز يعمل بنظام التشغيل Chrome.
list GET /admin/directory/v1/customer/{customerId}/devices/chromeos
استرداد قائمة مقسّمة على صفحات للأجهزة التي تعمل بنظام التشغيل Chrome ضمن حساب.
moveDevicesToOu POST /admin/directory/v1/customer/{customerId}/devices/chromeos/moveDevicesToOu
ينقل أو يدرج عدة أجهزة تعمل بنظام التشغيل Chrome إلى وحدة تنظيمية.
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: الأعضاء

الطُرق
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: الأجهزة الجوّالة

الطُرق
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: الوحدات التنظيمية

الطُرق
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: الامتيازات

الطُرق
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: الأدوار

الطُرق
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: المخططات

الطُرق
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: الرموز المميّزة

الطُرق
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
لعرض المجموعة الحالية من رموز التحقق الاحتياطية الصالحة للمستخدم المحدّد.