REST Resource: permissions

משאב: הרשאה

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

ל-methods מסוימות של משאבים (כמו 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

 מעדכן הרשאה.