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.