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 كجزء من مورد المستخدِمون. يجب تقديم المَعلمة 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 حدث تم تعديله من قِبل المستخدم

OrderBy

عمليات التعداد
EMAIL عنوان البريد الإلكتروني الأساسي للمستخدم
FAMILY_NAME اسم عائلة المستخدم.
GIVEN_NAME الاسم الأول للمستخدم.

الإسقاط

عمليات التعداد
BASIC لا تُدرِج أي حقول مخصّصة للمستخدم.
CUSTOM يجب تضمين الحقول المخصّصة من المخططات المطلوبة في customFieldMask.
FULL يجب تضمين جميع الحقول المرتبطة بهذا المستخدِم.

SortOrder

عمليات التعداد
ASCENDING ترتيب تصاعدي
DESCENDING ترتيب تنازلي

ViewType

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