Method: users.list

אחזור רשימה מחולקת של משתמשים שנמחקו או כל המשתמשים בדומיין.

בקשת HTTP

GET https://admin.googleapis.com/admin/directory/v1/users

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

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

פרמטרים
customFieldMask

string

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

string

המזהה הייחודי של חשבון Google Workspace של הלקוח. במקרה של חשבון עם כמה דומיינים, כדי לאחזר את כל המשתמשים של לקוח, צריך להשתמש בשדה הזה במקום ב-domain. אפשר גם להשתמש בכינוי my_customer כדי לייצג את customerId של החשבון. גם השדה customerId מוחזר כחלק מהמשאב משתמשים. עליך לספק את הפרמטר customer או את הפרמטר domain.
domain

string

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

enum (Event)

האירוע שעבורו מיועד המינוי (אם מדובר בהרשמה)
maxResults

integer

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

enum (OrderBy)

מאפיין שבו צריך להשתמש למיון תוצאות.
pageToken

string

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

enum (Projection)

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

string

מחרוזת שאילתה לחיפוש שדות משתמש. למידע נוסף על יצירת שאילתות של משתמשים, ראו חיפוש משתמשים.
showDeleted

string

אם המדיניות מוגדרת לערך true, מאחזרת את רשימת המשתמשים שנמחקו. (ברירת המחדל: false)
sortOrder

enum (SortOrder)

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

enum (ViewType)

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

גוף הבקשה

גוף הבקשה חייב להיות ריק.

גוף התשובה

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

ייצוג JSON 
{
  "kind": string,
  "trigger_event": string,
  "etag": string,
  "users": [
    {
      object (User)
    }
  ],
  "nextPageToken": string
}
שדות
kind

string

זה סוג המשאב.
trigger_event

string

האירוע שהפעיל את התגובה הזו (משמש רק במקרה של תגובת דחיפה)
etag

string

ה-ETag של המשאב.
users[]

object (User)

רשימה של אובייקטים של משתמשים.
nextPageToken

string

האסימון שמשמש לגישה לדף הבא בתוצאה הזו.

היקפי ההרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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

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

אירוע

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

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

OrderBy

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

היטל

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

SortOrder

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

ViewType

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