REST Resource: permissions

משאב: הרשאה

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

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

ייצוג JSON 
{
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
שדות
id

string

המזהה של המשתמש שההרשאה הזו מתייחסת אליו והוא זהה ל-permissionId במקורות המידע 'מידע כללי' ו'קבצים'. כששולחים בקשת drive.permissions.insert, יש לציין רק אחד מהשדות id או value, אלא אם סוג ההרשאה הוא anyone. במקרה כזה, המערכת מתעלמת גם מ-id וגם מ-value.
name

string

פלט בלבד. השם של ההרשאה הזו.
type

string

סוג החשבון. הערכים המותרים הם:

  • user
  • group
  • domain
  • anyone
role

string

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

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

תפקידים נוספים למשתמש הזה. מותר להשתמש רק ב-commenter, אבל יכול להיות שיתווספו בעתיד אפשרויות נוספות.
authKey
(deprecated)

string

פלט בלבד. הוּצא משימוש.
value

string

כתובת האימייל או שם הדומיין של הישות. משמש במהלך הוספות ולא מאוכלס בתגובות. כששולחים בקשת drive.permissions.insert, יש לציין רק אחד מהשדות id או value, אלא אם סוג ההרשאה הוא anyone. במקרה כזה, המערכת מתעלמת גם מ-id וגם מ-value.
kind

string

פלט בלבד. הערך הוא תמיד drive#permission.
emailAddress

string

פלט בלבד. כתובת האימייל של המשתמש או של הקבוצה שההרשאה הזו מתייחסת אליה. זהו שדה לפלט בלבד שנמצא כאשר סוג ההרשאה הוא user או group.
domain

string

פלט בלבד. שם הדומיין של הישות שאליה ההרשאה הזו מתייחסת. זהו שדה לפלט בלבד שנמצא כאשר סוג ההרשאה הוא user, group או domain.
etag

string

פלט בלבד. ה-ETag של ההרשאה.
permissionDetails[]

object

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

string

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

  • file
  • member
permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • reader
permissionDetails[].additionalRoles[]

string

פלט בלבד. תפקידים נוספים למשתמש הזה. האפשרות היחידה שזמינה היא commenter כרגע, אבל יכול להיות שבהמשך נוסיף עוד שירותים.
permissionDetails[].inheritedFrom

string

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

boolean

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

string

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

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

object

פלט בלבד. הוצאה משימוש: יש להשתמש במקום זאת ב-permissionDetails.
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

פלט בלבד. הוצאה משימוש: יש להשתמש במקום זאת ב-permissionDetails/permissionType.
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

פלט בלבד. הוצאה משימוש: יש להשתמש במקום זאת ב-permissionDetails/role.
teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

פלט בלבד. הוצאה משימוש: יש להשתמש במקום זאת ב-permissionDetails/additionalRoles.
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

פלט בלבד. הוצאה משימוש: יש להשתמש במקום זאת ב-permissionDetails/inheritedFrom.
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

פלט בלבד. הוצאה משימוש: יש להשתמש במקום זאת ב-permissionDetails/inherited.
deleted

boolean

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

string

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

boolean

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

שיטות

delete

 הרשאה זו מוחקת הרשאה מקובץ או מהאחסון שיתופי.

get

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

getIdForEmail

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

insert

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

list

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

patch

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

update

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