Method: users.get

استرداد مستخدم

طلب HTTP

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

يستخدم عنوان URL بنية gRPC Transcode.

معلّمات المسار

المعلّمات
userKey

string

يحدِّد المستخدم في طلب البيانات من واجهة برمجة التطبيقات. يمكن أن تكون القيمة عنوان البريد الإلكتروني الأساسي للمستخدم أو عنوان البريد الإلكتروني البديل أو رقم تعريف المستخدم الفريد.

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

المعلّمات
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

لمزيد من المعلومات، اطّلِع على دليل التفويض.

توقّعات الميزانية

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

نوع العرض

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