Method: users.get

אחזור משתמש.

בקשת HTTP

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

כתובת ה-URL כוללת תחביר gRPC קידוד מחדש.

פרמטרים של נתיב

פרמטרים
userKey

string

מזהה את המשתמש בבקשת ה-API. הערך יכול להיות כתובת האימייל הראשית של המשתמש, כתובת אימייל חלופית או מזהה משתמש ייחודי.

פרמטרים של שאילתה

פרמטרים
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.

תחזית

Enums
BASIC אין לכלול שדות מותאמים אישית למשתמש.
CUSTOM לכלול שדות מותאמים אישית מסכימות שביקשת ב-customFieldMask.
FULL יש לכלול את כל השדות המשויכים למשתמש הזה.

סוג התצוגה

Enums
admin_view התוצאות כוללות גם שדה מנהל מערכת וגם שדות שהם נחלת הכלל.
domain_public התוצאות כוללות רק שדות עבור המשתמש שגלויים למשתמשים אחרים בדומיין.