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 אירוע שעודכן על ידי המשתמש

סדר לפי

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

תחזית

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

SortOrder

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

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

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