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 |
لا تتضمّن النتائج سوى حقول المستخدم التي تكون مرئية للجميع للمستخدمين الآخرين في النطاق. |
إنّ محتوى هذه الصفحة مرخّص بموجب ترخيص Creative Commons Attribution 4.0 ما لم يُنصّ على خلاف ذلك، ونماذج الرموز مرخّصة بموجب ترخيص Apache 2.0. للاطّلاع على التفاصيل، يُرجى مراجعة سياسات موقع Google Developers. إنّ Java هي علامة تجارية مسجَّلة لشركة Oracle و/أو شركائها التابعين.
تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)
[null,null,["تاريخ التعديل الأخير: 2025-07-25 (حسب التوقيت العالمي المتفَّق عليه)"],[],[],null,["Retrieves a user.\n\nHTTP request\n\n`GET https://admin.googleapis.com/admin/directory/v1/users/{userKey}`\n\nThe URL uses [gRPC Transcoding](https://google.aip.dev/127) syntax.\n\nPath parameters\n\n| Parameters ||\n|-----------|---------------------------------------------------------------------------------------------------------------------------------------------|\n| `userKey` | `string` Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user ID. |\n\nQuery parameters\n\n| Parameters ||\n|-------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `customFieldMask` | `string` A comma-separated list of schema names. All fields from these schemas are fetched. This should only be set when `projection=custom`. |\n| `projection` | `enum (`[Projection](/workspace/admin/directory/reference/rest/v1/users/get#Projection)`)` What subset of fields to fetch for this user. |\n| `viewType` | `enum (`[ViewType](/workspace/admin/directory/reference/rest/v1/users/get#ViewType)`)` Whether to fetch the administrator-only or domain-wide public view of the user. For more information, see [Retrieve a user as a non-administrator](https://developers.google.com/workspace/admin/directory/v1/guides/manage-users#retrieve_users_non_admin). |\n\nRequest body\n\nThe request body must be empty.\n\nResponse body\n\nIf successful, the response body contains an instance of [User](/workspace/admin/directory/reference/rest/v1/users#User).\n\nAuthorization scopes\n\nRequires one of the following OAuth scopes:\n\n- `https://www.googleapis.com/auth/admin.directory.user`\n- `\n https://www.googleapis.com/auth/admin.directory.user.readonly`\n\nFor more information, see the [Authorization guide](/workspace/guides/configure-oauth-consent).\n\nProjection\n\n| Enums ||\n|----------|--------------------------------------------------------------------|\n| `BASIC` | Do not include any custom fields for the user. |\n| `CUSTOM` | Include custom fields from schemas requested in `customFieldMask`. |\n| `FULL` | Include all fields associated with this user. |\n\nViewType\n\n| Enums ||\n|-----------------|--------------------------------------------------------------------------------------------------|\n| `admin_view` | Results include both administrator-only and domain-public fields for the user. |\n| `domain_public` | Results only include fields for the user that are publicly visible to other users in the domain. |"]]
