Method: projects.locations.authorizations.acquireUserAuthorization

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

בקשת HTTP


POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/authorizations/*}:acquireUserAuthorization

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

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

פרמטרים
name

string

חובה. שם המשאב של Authorization. פורמט: projects/{project}/locations/{location}/authorizations/{authorization}

גוף הבקשה

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

גוף התשובה

הודעת תגובה לשיטה AuthorizationService.AcquireUserAuthorization.

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

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

object (RefreshTokenInfo)

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

accessToken

string

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

authorizationUri

string

כתובת URI שמפעילה את תהליך ההרשאה. הגדרת המועד שבו המשתמש צריך לקבל (מחדש) הרשאה.

היקפי הרשאות

נדרש אחד מהיקפי ההרשאות הבאים של 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 הבאה במשאב name:

  • discoveryengine.authorizations.storeUserAuthorization

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

RefreshTokenInfo

מתאר טוקן רענון.

ייצוג ב-JSON
{
  "scopes": [
    string
  ]
}
שדות
scopes[]

string

רשימת ההיקפים של הטוקן הזה.