REST Resource: permissions

משאב: הרשאה

הרשאה לקובץ. הרשאה מעניקה למשתמש, לקבוצה, לדומיין או לעולם גישה לקובץ או להיררכיה של תיקיות.

לשיטות משאבים מסוימות (כמו permissions.update) נדרש permissionId. אפשר להשתמש בשיטה permissions.list כדי לאחזר מזהה של קובץ, תיקייה או אחסון שיתופי.

ייצוג JSON
{
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
שדות
id

string

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

displayName

string

פלט בלבד. השם ה "יפה" של ערך ההרשאה. ריכזנו כאן רשימת דוגמאות לכל סוג של הרשאה:

  • user - השם המלא של המשתמש, כפי שמוגדר בחשבון Google שלו, למשל "Joe Smith.
  • group - שם קבוצת Google, כגון "האדמינים של החברה".
  • domain - מחרוזת של שם דומיין, כגון "thecompany.com".
  • anyone – לא קיים displayName.
type

string

סוג מקבל המענק. הערכים החוקיים כוללים:

  • user
  • group
  • domain
  • anyone

כשיוצרים הרשאה, אם הערך של type הוא user או group, צריך לציין emailAddress למשתמש או לקבוצה. כשהערך בשדה type הוא domain, יש לציין domain. לא נדרש מידע נוסף עבור סוג anyone.

kind

string

פלט בלבד. מזהה את סוג המשאב הזה. ערך: המחרוזת הקבועה "drive#permission".

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

פלט בלבד. המזהה של הפריט שממנו ההרשאה הזאת עברה בירושה. זהו שדה לפלט בלבד.

permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

פלט בלבד. האם ההרשאה הזו עברה בירושה. השדה הזה יאוכלס תמיד. זהו שדה לפלט בלבד.

emailAddress

string

כתובת האימייל של המשתמש או של הקבוצה שאליהם ההרשאה הזו מתייחסת.

role

string

התפקיד שהוענקה על ידי ההרשאה הזו. ייתכן שבהמשך תהיה תמיכה בערכים חדשים, אבל בשלב הזה אפשר להשתמש בערכים הבאים:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
allowFileDiscovery

boolean

האם ההרשאה מאפשרת לאתר את הקובץ באמצעות חיפוש. הדבר רלוונטי רק להרשאות מסוג domain או anyone.

domain

string

הדומיין שאליו ההרשאה הזו מתייחסת.

expirationTime

string

המועד שבו ההרשאה הזו תפוג (תאריך ושעה של RFC 3339). בין מועדי התפוגה חלות המגבלות הבאות:

  • ניתן להגדיר אותן רק בהרשאות של משתמשים וקבוצות.
  • השעה חייבת להיות בעתיד.
  • התאריך לא יכול לחול יותר משנה אחרי התאריך הנוכחי.
teamDrivePermissionDetails[]
(deprecated)

object

פלט בלבד. הוצא משימוש: פלט בלבד. במקומה צריך להשתמש במדיניות permissionDetails.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

הוצא משימוש: פלט בלבד. במקומה צריך להשתמש במדיניות permissionDetails/permissionType.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

הוצא משימוש: פלט בלבד. במקומה צריך להשתמש במדיניות permissionDetails/inheritedFrom.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

הוצא משימוש: פלט בלבד. במקומה צריך להשתמש במדיניות permissionDetails/role.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

הוצא משימוש: פלט בלבד. במקומה צריך להשתמש במדיניות permissionDetails/inherited.

deleted

boolean

פלט בלבד. האם החשבון המשויך להרשאה הזו נמחק. השדה הזה מתייחס רק להרשאות משתמשים וקבוצות.

view

string

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

pendingOwner

boolean

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

שיטות

create

יצירת הרשאה לקובץ או לאחסון שיתופי.

delete

מחיקת הרשאה.

get

מקבלת הרשאה לפי מזהה.

list

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

update

מעדכן הרשאה עם סמנטיקה של תיקון.