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