REST Resource: corpora.permissions

משאב: הרשאה

משאב הרשאה מעניק למשתמש, לקבוצה או לשאר העולם גישה למשאב ממשק ה-API של PaLM (למשל מודל מכוונן, מאגר).

תפקיד הוא אוסף של פעולות מותרות שמאפשרות למשתמשים לבצע פעולות ספציפיות במשאבי PaLM API. כדי שיהיו זמינים למשתמשים, לקבוצות או לחשבונות שירות, צריך להקצות תפקידים. כשמקצים תפקיד, למעשה נותנים לו את ההרשאות שהתפקיד כולל.

יש שלושה תפקידים קונצנטריים. כל תפקיד הוא קבוצת-על של הפעולות המותרות של התפקיד הקודם:

  • הקורא יכול להשתמש במשאב (למשל מודל מכוונן, מאגר) להסקת הנתונים
  • לכותב יש הרשאות קריאה, ובנוסף יכול לערוך ולשתף
  • לבעלים יש הרשאות כתיבה וגם יכול למחוק
ייצוג JSON 
{
  "name": string,
  "granteeType": enum (GranteeType),
  "emailAddress": string,
  "role": enum (Role)
}
שדות
name

string

פלט בלבד. מזהה. שם ההרשאה. במהלך היצירה ייווצר שם ייחודי. דוגמאות: AdjustModels/{tunedModel}/permissions/{permission} corpora/{corpus}/permissions/{permission} פלט בלבד.
granteeType

enum (GranteeType)

אפשרות. לא משתנה. סוג מקבל המענק.
emailAddress

string

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

enum (Role)

חובה. התפקיד שהוענקה על ידי ההרשאה הזו.

GranteeType

הגדרת הסוגים של מקבל ההרשאה.

טיפוסים בני מנייה (enums)
GRANTEE_TYPE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
USER מייצג משתמש. לאחר מכן, צריך לספק כתובת אימייל למשתמש.
GROUP מייצג קבוצה. לאחר מכן, צריך לספק כתובת אימייל לקבוצה.
EVERYONE מייצג גישה לכולם. אין צורך במידע נוסף.

תפקיד

מגדיר את התפקיד שמוענק על ידי ההרשאה הזו.

טיפוסים בני מנייה (enums)
ROLE_UNSPECIFIED ערך ברירת המחדל. הערך הזה לא בשימוש.
OWNER הבעלים יכול להשתמש במשאב, לעדכן, לשתף ולמחוק אותו.
WRITER בעל הרשאת כתיבה יכול להשתמש במשאב, לעדכן אותו ולשתף אותו.
READER הקוראים יכולים להשתמש במשאב.

שיטות

create

 יצירת הרשאה למשאב ספציפי.

delete

 מחיקת ההרשאה.

get

 קבלת מידע על הרשאה ספציפית.

list

 בתיבת הדו-שיח הזו מפורטים ההרשאות של המשאב הספציפי.

patch

 מתבצע עדכון של ההרשאה.