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

למידע נוסף, עיינו במדריך ההרשאות.

היטל

טיפוסים בני מנייה (enums)
BASIC אין לכלול שדות מותאמים אישית עבור המשתמש.
CUSTOM יש לכלול שדות מותאמים אישית מהסכימות המבוקשות ב-customFieldMask.
FULL יש לכלול את כל השדות שמשויכים למשתמש הזה.

ViewType

טיפוסים בני מנייה (enums)
admin_view התוצאות כוללות גם שדות של אדמין בלבד וגם שדות ציבוריים לדומיין עבור המשתמש.
domain_public התוצאות כוללות רק שדות עבור המשתמש שגלויים באופן ציבורי למשתמשים אחרים בדומיין.