Method: users.list

یک لیست صفحه بندی شده از کاربران حذف شده یا همه کاربران یک دامنه را بازیابی می کند.

درخواست HTTP

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

URL از دستور GRPC Transcoding استفاده می کند.

پارامترهای پرس و جو

پارامترها
customFieldMask

string

فهرستی از اسامی طرحواره جدا شده با کاما. همه فیلدهای این طرحواره ها واکشی می شوند. این فقط زمانی باید تنظیم شود که projection=custom .

customer

string

شناسه منحصر به فرد برای حساب Google Workspace مشتری. در مورد حساب چند دامنه ای، برای واکشی همه کاربران برای یک مشتری، از این فیلد به جای domain استفاده کنید. همچنین می توانید از نام مستعار my_customer برای نشان دادن customerId حساب خود استفاده کنید. customerId نیز به عنوان بخشی از منبع کاربران بازگردانده می شود. شما باید یا customer یا پارامتر domain را ارائه دهید.

domain

string

نام دامنه. از این فیلد برای دریافت کاربران تنها از یک دامنه استفاده کنید. برای بازگرداندن همه دامنه ها برای حساب مشتری، به جای آن از پارامتر query 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

رویدادی که این پاسخ را فعال کرد (فقط در مورد Push Response استفاده می‌شود)

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

برای اطلاعات بیشتر، به راهنمای مجوز مراجعه کنید.

رویداد

نوع رویداد اشتراک

Enums
ADD رویداد ایجاد شده توسط کاربر
DELETE رویداد حذف شده توسط کاربر
MAKE_ADMIN رویداد تغییر وضعیت ادمین کاربر
UNDELETE رویداد حذف شده توسط کاربر
UPDATE رویداد به روز شده توسط کاربر

سفارش توسط

Enums
EMAIL ایمیل اصلی کاربر
FAMILY_NAME نام خانوادگی کاربر
GIVEN_NAME نام داده شده کاربر

فرافکنی

Enums
BASIC هیچ فیلد سفارشی برای کاربر درج نکنید.
CUSTOM شامل فیلدهای سفارشی از طرحواره های درخواست شده در customFieldMask .
FULL شامل تمام فیلدهای مرتبط با این کاربر باشد.

مرتب سازی

Enums
ASCENDING ترتیب صعودی
DESCENDING ترتیب نزولی

ViewType

Enums
admin_view نتایج شامل فیلدهای فقط مدیر و دامنه عمومی برای کاربر است.
domain_public نتایج فقط شامل فیلدهایی برای کاربر است که به صورت عمومی برای سایر کاربران در دامنه قابل مشاهده است.