Method: users.get

אחזור משתמש.

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של 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 צריך לכלול את כל השדות שמשויכים למשתמש הזה.

ViewType

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