REST Resource: projects.locations.authorizations

משאב: הרשאה

משאב ההרשאה של Discovery Engine.

ייצוג ב-JSON 
{
  "name": string,
  "displayName": string,

  // Union field authorization_config can be only one of the following:
  "serverSideOauth2": {
    object (ServerSideOAuth2)
  }
  // End of list of possible types for union field authorization_config.
}
שדות
name

string

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

הוא חייב להיות מחרוזת מקודדת ב-UTF-8, עם מגבלת אורך של 1,024 תווים.
displayName

string

חובה. השם המוצג של ההרשאה.

הוא חייב להיות מחרוזת מקודדת ב-UTF-8 באורך של עד 128 תווים.
שדה איחוד authorization_config. הגדרת ההרשאות. הערך authorization_config יכול להיות רק אחד מהבאים:
serverSideOauth2

object (ServerSideOAuth2)

הגדרת OAuth2 בצד השרת.

ServerSideOAuth2

הגדרת OAuth2.

ייצוג ב-JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean
}
שדות
clientId

string

חובה. מזהה הלקוח ב-OAuth2.
clientSecret

string

חובה. הסוד של הלקוח ב-OAuth2.

הנתונים מוצפנים במנוחה.
tokenUri

string

חובה. נקודת הקצה של HTTP שמחליפה הרשאת לקוח בטוקן גישה.
authorizationUri

string

חובה. כתובת ה-URI שאליה המשתמש מנותב כשהוא צריך לאשר הרשאה. צריך לכלול את כל מה שנדרש להרשאה מוצלחת: מזהה OAuth, דגלים נוספים וכו'. דוגמה: https://accounts.google.com/o/oauth2/v2/auth?clientId=OAUTH_ID&scope=https://www.googleapis.com/auth/calendar.events&responseType=code&access_type=offline&prompt=consent

הפרמטר redirectUri יוחלף על ידי ממשק הקצה של חיפוש מבוסס-Vertex AI.
scopes[]

string

זה שינוי אופציונלי. היקפי ההרשאות שרוצים לבקש. דוגמה: https://www.googleapis.com/auth/calendar.events אם לא מציינים את הפרמטר הזה, לא מתבקשים היקפי הרשאות נוספים מעבר לאלה שנדרשים על ידי ה-URI של ההרשאה. אם ההגדרה הזו מוגדרת, היא תחליף את היקפי ההרשאות ב-URI של ההרשאה כשמתקבלת הרשאת משתמש.
pkceVerificationEnabled

boolean

זה שינוי אופציונלי. האם להפעיל אימות PKCE. https://datatracker.ietf.org/doc/html/rfc7636#section-3.1/

Methods

acquireUserAuthorization

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

create

 יוצר Authorization.

delete

 מוחקת Authorization.

get

 הפונקציה מחזירה Authorization.

list

 רשימה של כל הAuthorizations בדומיין Engine.

patch

 עדכון של Authorization

storeUserAuthorization

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