Method: projects.locations.userStores.batchUpdateUserLicenses

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/userStores/*}:batchUpdateUserLicenses

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

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

פרמטרים
parent

string

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

גוף הבקשה

גוף הבקשה מכיל נתונים במבנה הבא:

ייצוג ב-JSON 
{
  "deleteUnassignedUserLicenses": boolean,

  // Union field source can be only one of the following:
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
שדות
deleteUnassignedUserLicenses

boolean

זה שינוי אופציונלי. אם הערך הוא True, אם רישיונות המשתמשים הוסרו מהגדרת הרישיון המשויכת, רישיון המשתמש יימחק. כברירת מחדל, שהיא False, הרישיון של המשתמש יעודכן לסטטוס לא מוקצה.
שדה איחוד source. חובה. המקור של הקלט. הערך source יכול להיות רק אחד מהבאים:
inlineSource

object (InlineSource)

המקור בתוך הטקסט של תוכן הקלט להטמעות של מסמכים.

גוף התשובה

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.userStores.batchUpdateUserLicenses

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

InlineSource

מקור מוטבע להגדרת הקלט של השיטה userStores.batchUpdateUserLicenses.

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

object (UserLicense)

חובה. רשימה של רישיונות משתמשים שצריך לעדכן. לכל רישיון משתמש צריך להיות UserLicense.user_principal תקין.
updateMask

string (FieldMask format)

זה שינוי אופציונלי. רשימת השדות לעדכון.

זוהי רשימה מופרדת בפסיקים של שמות שדות שמוגדרים במלואם. דוגמה: "user.displayName,photo"