REST Resource: permissions

משאב: הרשאה

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

כברירת מחדל, בקשות הרשאות מחזירות רק קבוצת משנה של שדות. תמיד מוחזרים הסוג, המזהה, התפקיד והסוג של ההרשאה. כדי לאחזר שדות ספציפיים, אפשר לעיין במאמר https://developers.google.com/drive/api/guides/fields-parameter.

לחלק מהשיטות של המשאבים (כמו 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 שלו, למשל 'יוסי לוי'.
  • 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

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

pendingOwner

boolean

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

Methods

create

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

delete

מחיקת הרשאה.

get

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

list

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

update

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