REST Resource: permissions

משאב: הרשאה

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

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

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

pendingOwner

boolean

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

שיטות

create

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

delete

מחיקת הרשאה.

get

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

list

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

update

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