Method: projects.locations.userStores.userLicenses.list

רשימת רישיונות המשתמשים.

בקשת HTTP

GET https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/userStores/*}/userLicenses

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

פרמטרים של נתיב

פרמטרים
parent

string

חובה. שם המשאב של ההורה UserStore, בפורמט: projects/{project}/locations/{location}/userStores/{userStoreId}.

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

פרמטרים
pageSize

integer

זה שינוי אופציונלי. גודל הדף המבוקש. יכול להיות שהשרת יחזיר פחות פריטים מהמספר שצוין בבקשה. אם לא מציינים ערך, ברירת המחדל היא 10. הערך המקסימלי הוא 50. ערכים גבוהים יותר יומרו ל-50.

אם הערך בשדה הזה הוא שלילי, תוחזר שגיאה מסוג INVALID_ARGUMENT.
pageToken

string

זה שינוי אופציונלי. טוקן של דף שהתקבל מקריאה קודמת של userLicenses.list. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

כשמבצעים חלוקה לעמודים, כל הפרמטרים האחרים שסופקו ל-userLicenses.list חייבים להיות זהים לקריאה שסיפקה את הטוקן של הדף.
orderBy

string

זה שינוי אופציונלי. הסדר שבו מופיעים UserLicense. הערך חייב להיות רשימה מופרדת בפסיקים של שדות. סדר המיון שמוגדר כברירת מחדל הוא סדר עולה. כדי לציין סדר יורד בשדה, מוסיפים את הסיומת ' desc'. אין משמעות לרווחים מיותרים בתחביר.

שדות נתמכים:

  • licenseAssignmentState
  • userPrincipal
  • userProfile
  • last_login_date
  • updateTime

אם לא מגדירים את הסדר, ברירת המחדל היא לפי userPrincipal.

דוגמאות:

  • ‫userPrincipal desc כדי למיין לפי userPrincipal בסדר יורד.
  • ‫licenseAssignmentState כדי למיין לפי licenseAssignmentState בסדר עולה.
  • ‫last_login_date desc כדי למיין לפי last_login_date בסדר יורד.
  • ‫updateTime desc כדי למיין לפי updateTime בסדר יורד.
  • ‫last_login_date desc, userPrincipal כדי למיין לפי last_login_date בסדר יורד ואז לפי userPrincipal בסדר עולה.

גוף הבקשה

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

גוף התשובה

הודעת תגובה לUserLicenseService.ListUserLicenses.

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

ייצוג ב-JSON 
{
  "userLicenses": [
    {
      object (UserLicense)
    }
  ],
  "nextPageToken": string
}
שדות
userLicenses[]

object (UserLicense)

כל המינויים של הלקוח ב-UserLicense.
nextPageToken

string

טוקן שאפשר לשלוח כ-pageToken כדי לאחזר את הדף הבא. אם משמיטים את השדה הזה, לא יופיעו דפים נוספים.

היקפי הרשאות

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

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

ניתן למצוא מידע נוסף כאן: Authentication Overview.

הרשאות IAM

נדרשת הרשאת IAM הבאה במשאב parent:

  • discoveryengine.userStores.listUserLicenses

מידע נוסף מופיע במאמרי העזרה בנושא IAM.