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

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

אירוע

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

טיפוסים בני מנייה (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 התוצאות כוללות רק שדות עבור המשתמש שגלויים באופן ציבורי למשתמשים אחרים בדומיין.