REST Resource: permissions

منبع: اجازه

مجوزی برای یک فایل. یک مجوز به یک کاربر، گروه، دامنه یا کل جهان اجازه دسترسی به یک فایل یا سلسله مراتب پوشه را می‌دهد. برای اطلاعات بیشتر، به اشتراک‌گذاری فایل‌ها، پوشه‌ها و درایوها مراجعه کنید.

به طور پیش‌فرض، درخواست‌های مجوز فقط زیرمجموعه‌ای از فیلدها را برمی‌گردانند. kind مجوز، ID ، type و role همیشه برگردانده می‌شوند. برای بازیابی فیلدهای خاص، به بخش «بازگرداندن فیلدهای خاص» مراجعه کنید.

برخی از متدهای منابع (مانند 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,
  "inheritedPermissionsDisabled": boolean
}
فیلدها
id

string

فقط خروجی. شناسه این مجوز. این یک شناسه منحصر به فرد برای دارنده مجوز است و در منبع کاربر به عنوان permissionId منتشر می‌شود. شناسه‌ها باید به عنوان مقادیر مبهم در نظر گرفته شوند.

displayName

string

فقط خروجی. نام "pretty" مقدار مجوز. در زیر لیستی از مثال‌ها برای هر نوع مجوز آمده است:

  • user - نام کامل کاربر، همانطور که برای حساب گوگل او تعریف شده است، مانند "Dana A."
  • group - نام گروه گوگل، مانند "مدیران شرکت".
  • domain - نام دامنه رشته‌ای، مانند "cymbalgroup.com".
  • anyone - هیچ displayName وجود ندارد.
type

string

نوع دریافت‌کننده کمک هزینه. مقادیر پشتیبانی شده عبارتند از:

  • user
  • group
  • domain
  • anyone

هنگام ایجاد مجوز، اگر type user یا group باشد، باید یک emailAddress برای کاربر یا گروه ارائه دهید. اگر type domain باشد، باید یک domain ارائه دهید. اگر type anyone باشد، هیچ اطلاعات اضافی لازم نیست.

kind

string

فقط خروجی. نوع منبع را مشخص می‌کند. مقدار: رشته ثابت "drive#permission" .

permissionDetails[]

object

فقط خروجی. جزئیات اینکه آیا مجوزهای این مورد به ارث رسیده‌اند یا مستقیماً روی این مورد هستند.

permissionDetails[].permissionType

string

فقط خروجی. نوع مجوز برای این کاربر. مقادیر پشتیبانی شده عبارتند از:

  • file
  • member
permissionDetails[].inheritedFrom

string

فقط خروجی. شناسه‌ی آیتمی که این مجوز از آن به ارث رسیده است. این فقط برای آیتم‌های موجود در درایوهای مشترک پر می‌شود.

permissionDetails[].role

string

فقط خروجی. نقش اصلی این کاربر. مقادیر پشتیبانی شده عبارتند از:

  • owner
  • 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

فقط خروجی. اینکه آیا حساب مرتبط با این مجوز حذف شده است یا خیر. این فیلد فقط مربوط به مجوزهایی از نوع user یا group است.

view

string

نمای مربوط به این مجوز را نشان می‌دهد. فقط برای مجوزهایی که متعلق به یک نما هستند، پر می‌شود.

تنها مقادیر پشتیبانی‌شده published و metadata هستند:

  • published : نقش این مجوز publishedReader است.
  • metadata : این آیتم فقط برای نمای metadata قابل مشاهده است زیرا دسترسی محدودی دارد و دامنه حداقل دسترسی خواندن به والد را دارد. نمای metadata فقط در پوشه‌ها پشتیبانی می‌شود.

برای اطلاعات بیشتر، به بخش «دیدگاه‌ها» مراجعه کنید.

pendingOwner

boolean

اینکه آیا حساب مرتبط با این مجوز، مالک در حال بررسی است یا خیر. فقط مجوزهایی از نوع user برای فایل‌هایی که در درایو مشترک نیستند، پر می‌شود.

inheritedPermissionsDisabled

boolean

وقتی true ، فقط سازمان‌دهندگان، مالکان و کاربرانی که مجوزهایشان مستقیماً به آیتم اضافه شده است می‌توانند به آن دسترسی داشته باشند.

روش‌ها

create

 برای یک فایل یا درایو مشترک، مجوز ایجاد می‌کند.

delete

 یک مجوز را حذف می‌کند.

get

 با ارائه کارت شناسایی مجوز می‌گیرد.

list

 مجوزهای یک فایل یا درایو مشترک را فهرست می‌کند.

update

 یک مجوز را با معانی وصله به‌روزرسانی می‌کند.