REST Resource: projects.locations.authorizations

משאב: הרשאה

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

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

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "serverSideOauth2": {
    object (ServerSideOAuth2)
  }
  // End of mutually exclusive fields.
}
שדות
name

string

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

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

string

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

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

object (ServerSideOAuth2)

הגדרת OAuth2 בצד השרת.
סוף השדות הבלעדיים.

ServerSideOAuth2

הגדרת OAuth2.

ייצוג ב-JSON 
{
  "clientId": string,
  "clientSecret": string,
  "tokenUri": string,
  "authorizationUri": string,
  "scopes": [
    string
  ],
  "pkceVerificationEnabled": boolean,
  "basicAuthenticationEnabled": boolean,
  "privateNetworkConfig": {
    object (PrivateNetworkConfig)
  }
}
שדות
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/
basicAuthenticationEnabled

boolean

זה שינוי אופציונלי. האם החלפת אסימוני OAuth משתמשת באימות בסיסי של HTTP ‏ (client_secret_basic) במקום לשלוח את פרטי הכניסה של הלקוח בגוף הבקשה (client_secret_post). אם הערך הוא true, פרטי הכניסה (clientId:clientSecret) מקודדים ב-Base64 ונשלחים בכותרת Authorization. חלק מספקי OAuth (לדוגמה, Splunk) דורשים client_secret_basic. אם המדיניות מוגדרת כ-false או לא מוגדרת, המערכת משתמשת בברירת המחדל client_secret_post.
privateNetworkConfig

object (PrivateNetworkConfig)

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

PrivateNetworkConfig

מזהה את המופע שמארח ספק OAuth שאפשר להגיע אליו רק דרך רשת פרטית.

ייצוג ב-JSON 
{
  "instanceResource": string
}
שדות
instanceResource

string

חובה. שם המשאב של המופע שמארח את ספק ה-OAuth. ב-Looker, המכונה של Looker, בתבנית projects/{project}/locations/{location}/instances/{instance}.

Methods

acquireUserAuthorization

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

create

 יוצר Authorization.

delete

 מוחקת Authorization.

get

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

list

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

patch

 עדכון של Authorization

storeUserAuthorization

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