Method: users.list

لاسترداد قائمة مقسّمة على صفحات للمستخدمين المحذوفين أو جميع المستخدمين في نطاق معيّن.

طلب HTTP

GET https://admin.googleapis.com/admin/directory/v1/users

يستخدم عنوان URL بنية gRPC Transcode.

معامِلات طلب البحث

المَعلمات
customFieldMask

string

قائمة بأسماء المخططات مفصولة بفواصل. يتم جلب جميع الحقول من هذه المخططات. يجب ألا يتم ضبط هذه السياسة إلا في projection=custom.
customer

string

المعرّف الفريد لحساب العميل على Google Workspace. إذا كان الحساب متعدّد النطاقات، يُرجى استخدام هذا الحقل بدلاً من domain لجلب جميع المجموعات لعميل. يمكنك أيضًا استخدام العنوان البديل للبريد الإلكتروني my_customer لتمثيل customerId في حسابك. يتم عرض customerId أيضًا كجزء من مورد المستخدمون. يجب تقديم إما المَعلمة customer أو المَعلمة domain.
domain

string

اسم النطاق استخدِم هذا الحقل للحصول على مجموعات من نطاق واحد فقط. لعرض جميع النطاقات لحساب عميل، استخدِم معلَمة طلب البحث customer بدلاً من ذلك. يجب تقديم المَعلمة customer أو المَعلمة domain.
event

enum (Event)

الحدث الذي تم الاشتراك فيه (في حال الاشتراك)
maxResults

integer

الحد الأقصى لعدد النتائج المطلوب عرضها.
orderBy

enum (OrderBy)

الموقع المطلوب استخدامه لعرض النتائج.
pageToken

string

الرمز المميز لتحديد الصفحة التالية في القائمة
projection

enum (Projection)

مجموعة فرعية من الحقول التي يجب استرجاعها لهذا المستخدم.
query

string

سلسلة طلب البحث للبحث في حقول المستخدم لمزيد من المعلومات عن إنشاء طلبات بحث المستخدم، يُرجى الاطِّلاع على البحث عن المستخدمين.
showDeleted

string

في حال ضبط السياسة على true، سيتم استرداد قائمة المستخدمين المحذوفين. (تلقائي: false)
sortOrder

enum (SortOrder)

ما إذا كان سيتم عرض النتائج بترتيب تصاعدي أو تنازلي، مع تجاهل حالة الأحرف.
viewType

enum (ViewType)

ما إذا كان سيتم جلب العرض العلني للمستخدم فقط أو للمشرف على مستوى النطاق. ولمزيد من المعلومات، يُرجى الاطّلاع على استرداد مستخدم بصفتك مشرفًا.

نص الطلب

يجب أن يكون نص الطلب فارغًا.

نص الاستجابة

إذا كانت الاستجابة ناجحة، سيحتوي نص الاستجابة على بيانات بالبنية التالية:

تمثيل JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
الحقول
kind

string

نوع هذا المورد
trigger_event

string

الحدث الذي أدى إلى تفعيل هذه الاستجابة (يُستخدَم فقط في حال الردّ على الإشعارات)
etag

string

ETag للمورد.
users[]

object (User)

قائمة بكائنات المستخدمين
nextPageToken

string

الرمز المميّز المستخدَم للوصول إلى الصفحة التالية من هذه النتيجة

نطاقات الأذونات

يتطلب ذلك أحد نطاقات 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 لا تتضمن النتائج سوى حقول المستخدم التي تكون مرئية بشكلٍ علني للمستخدمين الآخرين في النطاق.