Method: users.get

لاسترداد مستخدم.

طلب HTTP

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

يستخدم عنوان URL بنية تحويل الترميز gRPC.

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

المَعلمات
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 ضمِّن جميع الحقول المرتبطة بهذا المستخدم.

ViewType

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