Method: users.get

یک کاربر را بازیابی می کند.

درخواست HTTP

GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}

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

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

مولفه های
userKey

string

کاربر را در درخواست API شناسایی می کند. این مقدار می تواند آدرس ایمیل اصلی کاربر، آدرس ایمیل مستعار یا شناسه کاربری منحصر به فرد باشد.

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

مولفه های
customFieldMask

string

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

projection

enum ( Projection )

چه زیر مجموعه ای از فیلدها برای این کاربر واکشی شود.

viewType

enum ( ViewType )

آیا برای واکشی نمای عمومی کاربر فقط برای سرپرست یا دامنه. برای اطلاعات بیشتر، به بازیابی یک کاربر به عنوان غیر سرپرست مراجعه کنید.

درخواست بدن

بدنه درخواست باید خالی باشد.

بدن پاسخگو

در صورت موفقیت آمیز بودن، بدنه پاسخ حاوی نمونه ای از User است.

محدوده مجوز

به یکی از حوزه های OAuth زیر نیاز دارد:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly

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

فرافکنی

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

ViewType

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