Method: projects.locations.identityMappingStores.listIdentityMappings

מציג רשימה של מיפויי זהויות במאגר מיפויי זהויות.

בקשת HTTP


GET https://discoveryengine.googleapis.com/v1beta/{identityMappingStore=projects/*/locations/*/identityMappingStores/*}:listIdentityMappings

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

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

פרמטרים
identityMappingStore

string

חובה. השם של מאגר מיפוי הזהויות שבו רוצים להציג את הרשומות של מיפוי הזהויות. פורמט: projects/{project}/locations/{location}/identityMappingStores/{identityMappingStore}

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

פרמטרים
pageSize

integer

המספר המקסימלי של מיפויי זהויות שיוחזרו. אם לא מציינים ערך, ברירת המחדל היא 2,000. הערך המקסימלי המותר הוא 10,000. ערכים גבוהים יותר יומרו ל-10,000.
pageToken

string

טוקן של דף שהתקבל מקריאה קודמת של identityMappingStores.listIdentityMappings. צריך להזין את הטוקן כדי לאחזר את הדף הבא.

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

גוף הבקשה

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

גוף התשובה

הודעת תגובה ל-IdentityMappingStoreService.ListIdentityMappings

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

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

object (IdentityMappingEntry)

רשומות מיפוי הזהויות.
nextPageToken

string

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

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.identityMappingStores.listIdentityMappings

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