تتيح واجهة برمجة التطبيقات Directory API في Admin SDK لمشرفي نطاقات المؤسسات عرض وإدارة المستخدمين والمجموعات والأجهزة والموارد ذات الصلة في مؤسساتهم. توفّر واجهات برمجة تطبيقات Cloud Identity طرقًا إضافية لإدارة بعض الموارد نفسها.
الخدمة: admin.googleapis.com
لطلب هذه الخدمة، ننصح باستخدام مكتبات العميل التي توفّرها Google. إذا كان تطبيقك يحتاج إلى استخدام مكتباتك الخاصة لطلب هذه الخدمة، استخدِم المعلومات التالية عند طلب بيانات من واجهة برمجة التطبيقات.
مستند الاستكشاف
مستند الاستكشاف هو عبارة عن مواصفات يمكن أن تقرأها الآلة لوصف REST API واستخدامها. وهو يُستخدم لإنشاء مكتبات العميل ومكوّنات 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 تعرض هذه السمة قائمة بموفّري خدمات التطبيقات الذين أصدرهم مستخدم. |
مورد REST: chromeosdevices
| الطُرق | |
|---|---|
action |
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. |
countChromeOsDevices |
GET /admin/directory/v1/customer/{customerId}/devices/chromeos:countChromeOsDevices تعرض هذه السمة عدد أجهزة 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 يسترد هذا الأمر جميع مجموعات نطاق أو مستخدم معيّن باستخدام userKey (يتم تقسيم النتائج إلى صفحات). |
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 يستردّ قائمة مقسّمة إلى صفحات بجميع 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 تعرِض هذه الطريقة المجموعة الحالية من رموز التحقّق الاحتياطية الصالحة للمستخدم المحدّد. |