Method: projects.locations.collections.dataConnector.acquireAndStoreRefreshToken

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

בקשת HTTP

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

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

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

פרמטרים
name

string

חובה. משאב של מחבר.

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

גוף הבקשה

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

ייצוג JSON 
{
  "scopes": [
    string
  ],
  "fullRedirectUri": string,
  "instanceUri": string
}
שדות
scopes[]

string

היקפי ההרשאות של קוד ההרשאה ושל אסימון הרענון.
fullRedirectUri

string

חובה. ה-URI שאליו המשתמש מופנה לאחר האישור, כולל כל הפרמטרים. לדוגמה, https://example.com/redir?code=5
instanceUri

string

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

גוף התשובה

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

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

ייצוג JSON 
{
  "additionalOauthResponses": [
    {
      object (AdditionalOAuthResponse)
    }
  ]
}
שדות
additionalOauthResponses[]

object (AdditionalOAuthResponse)

זה שינוי אופציונלי. תשובות נוספות של OAuth מתשובת ההרשאה. השדה הזה הוא אופציונלי ולא תמיד יופיע בו מידע. זה תלוי בסוג המחבר ובתגובת ההרשאה.

היקפי הרשאות

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

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

AdditionalOAuthResponse

תשובות נוספות של OAuth מתשובת ההרשאה.

ייצוג JSON 
{
  "key": string,

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "stringValue": string,
  "intValue": string,
  "boolValue": boolean
  // End of mutually exclusive fields.
}
שדות
key

string

המפתח של תגובת ה-OAuth הנוספת.
הערך של תגובת ה-OAuth הנוספת. בהמשך מפורטת רשימה של שדות שאי אפשר להשתמש בהם בו-זמנית. רק אחד מהשדות הבאים יוגדר בתשובה:
stringValue

string

ערך המחרוזת של תגובת ה-OAuth הנוספת.
intValue

string (int64 format)

הערך השלם של תגובת OAuth הנוספת.
boolValue

boolean

הערך הבוליאני של תגובת OAuth הנוספת.
סוף השדות הבלעדיים.