Method: users.list

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

בקשת HTTP

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

כתובת ה-URL משתמשת בתחביר של Transcoding של gRPC.

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

פרמטרים
customFieldMask

string

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

customer

string

המזהה הייחודי של חשבון Google Workspace של הלקוח. אם מדובר בחשבון עם כמה דומיינים, כדי לאחזר את כל המשתמשים של לקוח, צריך להשתמש בשדה הזה במקום בשדה domain. אפשר גם להשתמש בכתובת החלופית my_customer כדי לייצג את customerId של החשבון. הערך customerId מוחזר גם כחלק מהמשאב Users. חובה לספק את הפרמטר 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

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

אירוע

סוג האירוע Subscription

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