Method: projects.locations.completeExternalIdentities

השיטה הזו מספקת הצעות למשתמשים ולקבוצות שמנוהלים בספק חיצוני של זהויות, על סמך הקידומת שצוינה.

בקשת HTTP

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*}:completeExternalIdentities

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

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

פרמטרים
parent

string

חובה. שם משאב המיקום של ההורה, למשל projects/*/locations/global.

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

פרמטרים
prefixQuery

string

חובה. הקידומת לחיפוש. למשתמשים, הקידומת הזו מותאמת ל-primaryEmail. במקרה של קבוצות, הקידומת הזו מותאמת ל-displayName. ההתאמה לא תלוית אותיות רישיות.
maxSuggestions

integer

זה שינוי אופציונלי. מספר התוצאות המקסימלי של משתמשים וקבוצות שיוחזרו. יכול להיות שהשירות יחזיר פחות מהערך הזה.

אם לא מציינים ערך, יוחזרו לכל היותר 6 תוצאות. המגבלה מחולקת באופן שווה ככל האפשר בין משתמשים וקבוצות. לדוגמה, אם הערך של maxSuggestions הוא 7, יכול להיות שהשירות יחזיר 4 משתמשים ו-3 קבוצות. אם יש פחות הצעות מסוג מסוים ממחצית המגבלה, יכול להיות שהסוג השני יחזיר יותר הצעות עד למגבלה maxSuggestions.
entityTypeFilter

enum (EntityTypeFilter)

זה שינוי אופציונלי. סוג הישויות לאחזור. אם לא מציינים סוג, כל סוגי הישויות יוחזרו.
useScimIdentities

boolean

זה שינוי אופציונלי. האם להשתמש בזהויות SCIM להשלמת זהויות חיצוניות. אם הערך הוא false, נפעיל את Microsoft Graph API כדי לאחזר את הזהויות החיצוניות.

גוף הבקשה

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

גוף התשובה

הודעת תגובה לCompletionService.CompleteExternalIdentities.

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

ייצוג ב-JSON 
{
  "externalIdentities": [
    {
      object (ExternalIdentity)
    }
  ]
}
שדות
externalIdentities[]

object (ExternalIdentity)

רשימת הזהויות החיצוניות שתואמות לשאילתה.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.locations.completeExternalIdentities

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

EntityTypeFilter

סוג הישויות לאחזור.

טיפוסים בני מנייה (enum)
ENTITY_TYPE_FILTER_UNSPECIFIED מסנן של סוג ישות לא מוגדר.
USERS משתמשים עם הרשאת אחזור בלבד.
GROUPS אחזור של קבוצות בלבד.

ExternalIdentity

זהות חיצונית שמייצגת משתמש או קבוצה. המשתמש או הקבוצה האלה מגיעים מספק זהויות חיצוני (IdP).

ייצוג ב-JSON 
{
  "externalId": string,
  "displayName": string,

  // Union field EntityType can be only one of the following:
  "userMetadata": {
    object (UserMetadata)
  },
  "groupMetadata": {
    object (GroupMetadata)
  }
  // End of list of possible types for union field EntityType.
}
שדות
externalId

string

המזהה הייחודי של צד ג' (externalId) של הישות (משתמש או קבוצה).
displayName

string

השם המוצג של המשתמש או הקבוצה.
שדה איחוד EntityType. סוג הזהות החיצונית. השדה הזה משמש לציון סוג הישות (משתמש או קבוצה) והמטא-נתונים התואמים. הערך EntityType יכול להיות רק אחד מהבאים:
userMetadata

object (UserMetadata)

מטא-נתונים שמתאימים למשתמש החיצוני.
groupMetadata

object (GroupMetadata)

מטא-נתונים שמתאימים למשתמש החיצוני.

UserMetadata

מטא-נתונים שמתאימים למשתמש החיצוני.

ייצוג ב-JSON 
{
  "givenName": string,
  "familyName": string,
  "primaryEmail": string
}
שדות
givenName

string

השם הפרטי של המשתמש.
familyName

string

שם המשפחה של המשתמש.
primaryEmail

string

כתובת האימייל הראשית של המשתמש.

GroupMetadata

בסוג הזה אין שדות.

מטא-נתונים שמתאימים לקבוצה החיצונית.