REST Resource: permissions

משאב: הרשאה

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

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

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

string

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

object

פלט בלבד. פרטים על כך שההרשאות בפריט הזה עוברות בירושה או שהן ניתנות ישירות לפריט הזה.
permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].role

string

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

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

string

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

string

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

boolean

פלט בלבד. האם ההרשאה הזו עוברת בירושה. השדה הזה תמיד מאוכלס.
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.
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
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 של ההרשאה.
expirationDate

string

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

  • אפשר להגדיר אותם רק בהרשאות של משתמשים וקבוצות
  • התאריך חייב להיות בעתיד
  • התאריך לא יכול להיות יותר משנה בעתיד
deleted

boolean

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

string

מציין את התצוגה של ההרשאה הזו. השדה מאוכלס רק לגבי הרשאות ששייכות לתצוגה מפורטת.

published

וגם

metadata

הם הערכים הנתמכים היחידים.

  • published

    : התפקיד של ההרשאה הוא published_reader.

  • metadata

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

    metadata

    בשלב הזה יש תמיכה בתצוגה הזו רק בתיקיות.

pendingOwner

boolean

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

boolean

אם הערך הוא true, רק המארגנים, הבעלים והמשתמשים עם ההרשאות שנוספו ישירות לפריט יכולים לגשת אליו.

Methods

delete

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

get

 אחזור הרשאה לפי מזהה.

getIdForEmail

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

insert

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

list

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

patch

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

update

 עדכון הרשאה.