Method: users.watch

מעקב אחר שינויים ברשימת המשתמשים.

בקשת HTTP

POST https://admin.googleapis.com/admin/directory/v1/users/watch

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

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

פרמטרים
domain

string

שם הדומיין. אם רוצים לקבל משתמשים מהדומיין הזה בלבד, צריך למלא את השדה הזה. כדי להחזיר את כל המשתמשים בשדה מרובה-דומיינים, מלא במקום זאת בשדה 'לקוח'."
customer

string

המזהה הקבוע של חשבון Google Workspace. במקרה של מספר דומיינים, כדי לאחזר את כל המשתמשים עבור לקוח, צריך למלא את השדה הזה במקום את הדומיין.
event

enum (EventType)

אירועים לצפייה.
customFieldMask

string

רשימה מופרדת בפסיקים של שמות סכימות. כל השדות מהסכימות האלה מאוחזרים. יש להגדיר זאת רק כאשר projection=custom.
maxResults

integer

המספר המקסימלי של תוצאות להחזרה.
orderBy

enum (OrderBy)

עמודה שתשמש למיון התוצאות
pageToken

string

אסימון לציון הדף הבא ברשימה
projection

enum (Projection)

איזו קבוצת משנה של שדות יש לאחזר עבור המשתמש הזה.
query

string

חיפוש מחרוזת שאילתה. צריכה להיות בפורמט "". התיעוד המלא זמין בכתובת https: https: //developers.google.com/admin-sdk/directory/v1/guides/search-users
showDeleted

string

אם המדיניות מוגדרת כ-True, מאחזרת את רשימת המשתמשים שנמחקו. (ברירת מחדל: FALSE)
sortOrder

enum (SortOrder)

אם להחזיר תוצאות בסדר עולה או יורד.
viewType

enum (ViewType)

האם לאחזר את התצוגה הציבורית של המשתמש עבור מנהל המערכת בלבד או עבור הדומיין כולו. מידע נוסף זמין במאמר אחזור משתמש ללא הרשאת אדמין.

גוף הבקשה

גוף הבקשה מכיל מופע של SubscriptionChannel.

גוף התשובה

אם הפעולה בוצעה ללא שגיאות, גוף התגובה מכיל מופע של SubscriptionChannel.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של OAuth:

  • https://www.googleapis.com/auth/admin.directory.user
  • https://www.googleapis.com/auth/admin.directory.user.readonly
  • https://www.googleapis.com/auth/cloud-platform

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

EventType

סוג האירוע 'מינוי'

טיפוסים בני מנייה (enums)
ADD אירוע שנוצר על ידי משתמש
DELETE אירוע שנמחק על ידי משתמש
MAKE_ADMIN אירוע שינוי סטטוס אדמין של משתמש
UNDELETE אירוע שמחיקתו בוטלה על ידי משתמש
UPDATE אירוע שעודכן על ידי משתמש

OrderBy

טיפוסים בני מנייה (enums)
EMAIL כתובת האימייל הראשית של המשתמש.
FAMILY_NAME שם המשפחה של המשתמש.
GIVEN_NAME השם הפרטי של המשתמש.

היטל

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

SortOrder

טיפוסים בני מנייה (enums)
ASCENDING סדר עולה.
DESCENDING סדר יורד.

ViewType

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