Method: projects.locations.collections.dataConnector.acquireAccessToken

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

בקשת HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/collections/*/dataConnector}:acquireAccessToken

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

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

פרמטרים
name

string

חובה. שם המשאב של המחבר שעבורו מתבצעת שאילתה לגבי אסימון.

גוף הבקשה

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

ייצוג JSON 
{
  "scope": string,
  "action": string
}
שדות
scope

string

זה שינוי אופציונלי. היקף ההרשאות לבקשת טוקן הגישה. אם מציינים היקף הרשאות, הוא יחליף את היקף ברירת המחדל.
action

string

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

גוף התשובה

הודעת תגובה לשיטה DataConnectorService.AcquireAccessToken.

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

ייצוג JSON 
{
  "refreshTokenInfo": {
    object (RefreshTokenInfo)
  },
  "accessToken": string
}
שדות
refreshTokenInfo

object (RefreshTokenInfo)

מידע על טוקן הרענון שנשמר ומשמש ליצירת טוקן הגישה.
accessToken

string

אסימון הגישה שנוצר.

היקפי הרשאות

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

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

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

הרשאות IAM

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

  • discoveryengine.dataConnectors.acquireAccessToken

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