REST Resource: permissions

משאב: הרשאה

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

כברירת מחדל, בקשות הרשאה מחזירות רק קבוצת משנה של שדות. ההרשאות kind,‏ ID,‏ type ו-role תמיד מוחזרות. כדי לאחזר שדות ספציפיים, אפשר לעיין במאמר החזרת שדות ספציפיים.

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

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

object

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

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

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

string

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

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

מידע נוסף זמין במאמר בנושא תפקידים והרשאות.
permissionDetails[].inherited

boolean

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

string

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

string

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

  • ‫user – השם המלא של המשתמש, כפי שהוגדר בחשבון Google שלו, למשל Dana A.
  • ‫group – שם קבוצת Google, למשל 'האדמינים של החברה'.
  • ‫domain – שם הדומיין כמחרוזת, כמו 'cymbalgroup.com'.
  • ‫anyone – לא מופיע displayName.
type

string

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

  • user
  • group
  • domain
  • anyone

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

string

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

string

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

string

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

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

מידע נוסף זמין במאמר בנושא תפקידים והרשאות.
allowFileDiscovery

boolean

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

string

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

string

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

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

boolean

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

string

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

הערכים הנתמכים היחידים הם published ו-metadata:

  • ‫published: התפקיד של ההרשאה הוא publishedReader.
  • ‫metadata: הפריט גלוי רק בתצוגה metadata כי הגישה אליו מוגבלת, ולתחום יש לפחות הרשאת קריאה להורה. התצוגה metadata נתמכת רק בתיקיות.

מידע נוסף זמין במאמר בנושא צפיות.
pendingOwner

boolean

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

boolean

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

Methods

create

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

delete

 מחיקת הרשאה.

get

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

list

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

update

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