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