لاسترداد قائمة مقسّمة على صفحات للمستخدمين المحذوفين أو جميع المستخدمين في نطاق معيّن.
طلب HTTP
GET https://admin.googleapis.com/admin/directory/v1/users
يستخدم عنوان URL بنية gRPC Transcode.
معامِلات طلب البحث
المَعلمات | |
---|---|
customFieldMask |
قائمة بأسماء المخططات مفصولة بفواصل. يتم جلب جميع الحقول من هذه المخططات. يجب ألا يتم ضبط هذه السياسة إلا في |
customer |
المعرّف الفريد لحساب العميل على Google Workspace. إذا كان الحساب متعدّد النطاقات، يُرجى استخدام هذا الحقل بدلاً من |
domain |
اسم النطاق استخدِم هذا الحقل للحصول على مجموعات من نطاق واحد فقط. لعرض جميع النطاقات لحساب عميل، استخدِم معلَمة طلب البحث |
event |
الحدث الذي تم الاشتراك فيه (في حال الاشتراك) |
maxResults |
الحد الأقصى لعدد النتائج المطلوب عرضها. |
orderBy |
الموقع المطلوب استخدامه لعرض النتائج. |
pageToken |
الرمز المميز لتحديد الصفحة التالية في القائمة |
projection |
مجموعة فرعية من الحقول التي يجب استرجاعها لهذا المستخدم. |
query |
سلسلة طلب البحث للبحث في حقول المستخدم لمزيد من المعلومات عن إنشاء طلبات بحث المستخدم، يُرجى الاطِّلاع على البحث عن المستخدمين. |
showDeleted |
في حال ضبط السياسة على |
sortOrder |
ما إذا كان سيتم عرض النتائج بترتيب تصاعدي أو تنازلي، مع تجاهل حالة الأحرف. |
viewType |
ما إذا كان سيتم جلب العرض العلني للمستخدم فقط أو للمشرف على مستوى النطاق. ولمزيد من المعلومات، يُرجى الاطّلاع على استرداد مستخدم بصفتك مشرفًا. |
نص الطلب
يجب أن يكون نص الطلب فارغًا.
نص الاستجابة
إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:
تمثيل JSON |
---|
{
"kind": string,
"trigger_event": string,
"etag": string,
"users": [
{
object ( |
الحقول | |
---|---|
kind |
نوع هذا المورد |
trigger_event |
الحدث الذي أدى إلى تفعيل هذه الاستجابة (يُستخدَم فقط في حال الردّ على الإشعارات) |
etag |
ETag للمورد. |
users[] |
قائمة بكائنات المستخدمين |
nextPageToken |
الرمز المميّز المستخدَم للوصول إلى الصفحة التالية من هذه النتيجة |
نطاقات الأذونات
يتطلب ذلك أحد نطاقات OAuth التالية:
https://www.googleapis.com/auth/admin.directory.user
https://www.googleapis.com/auth/admin.directory.user.readonly
https://www.googleapis.com/auth/cloud-platform
لمزيد من المعلومات، اطّلِع على دليل التفويض.
الحدث
نوع حدث الاشتراك
عمليات التعداد | |
---|---|
ADD |
حدث من إنشاء المستخدم |
DELETE |
حدث حذف المستخدم |
MAKE_ADMIN |
حدث تغيير حالة مشرف المستخدم |
UNDELETE |
حدث إلغاء حذف المستخدم |
UPDATE |
حدث تم تعديله من قِبل المستخدم |
ترتيب حسب
عمليات التعداد | |
---|---|
EMAIL |
البريد الإلكتروني الأساسي للمستخدم. |
FAMILY_NAME |
اسم عائلة المستخدم |
GIVEN_NAME |
الاسم المُقدَّم للمستخدم |
توقّعات الميزانية
عمليات التعداد | |
---|---|
BASIC |
يجب عدم تضمين أي حقول مخصّصة للمستخدم. |
CUSTOM |
أدرِج الحقول المخصّصة في المخططات المطلوبة في customFieldMask . |
FULL |
تضمين جميع الحقول المرتبطة بهذا المستخدم. |
SortOrder
عمليات التعداد | |
---|---|
ASCENDING |
ترتيب تصاعدي. |
DESCENDING |
ترتيب تنازلي. |
نوع العرض
عمليات التعداد | |
---|---|
admin_view |
تتضمن النتائج كلاً من الحقول الخاصة بالمشرف فقط والنطاق العام للمستخدم. |
domain_public |
لا تتضمن النتائج سوى حقول المستخدم التي تكون مرئية بشكلٍ علني للمستخدمين الآخرين في النطاق. |