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

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

תחזית

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

סוג התצוגה המפורטת

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