Method: users.list

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

طلب HTTP

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

يستخدِم عنوان URL بنية تحويل ترميز gRPC.

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

المعلمات
customFieldMask

string

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

string

المعرّف الفريد لحساب العميل على Google Workspace. في حالة وجود حساب متعدد النطاقات، استخدم هذا الحقل بدلاً من domain لجلب جميع المستخدمين لأحد العملاء. يمكنك أيضًا استخدام الاسم المستعار my_customer لتمثيل customerId في حسابك. ويتم عرض customerId أيضًا كجزء من مورد Users (المستخدمون). يجب تقديم المعلَمة 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 ترتيب تنازلي.

ViewType

عمليات التعداد
admin_view تتضمن النتائج كلاً من الحقول المخصّصة للمشرف فقط والحقل العلني للنطاق للمستخدم.
domain_public لا تتضمّن النتائج سوى حقول المستخدم التي تكون مرئية بشكل علني للمستخدمين الآخرين في النطاق.