Method: users.get

يستعيد مستخدم.

طلب HTTP

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

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

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

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

للحصول على مزيد من المعلومات، يُرجى الاطّلاع على نظرة عامة على OAuth 2.0.

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

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

نوع المشاهدة

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