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

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

הרשאות IAM

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

  • discoveryengine.authorizations.storeUserAuthorization

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

RefreshTokenInfo

תיאור של טוקן רענון.

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

string

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