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 date-time ). زمان انقضا دارای محدودیت های زیر است:

  • آنها را فقط می توان روی مجوزهای کاربر و گروه تنظیم کرد.
  • زمان باید در آینده باشد.
  • این زمان نمی تواند بیش از یک سال در آینده باشد.
deleted

boolean

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

view

string

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

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

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

برای اطلاعات بیشتر، مشاهده ها را ببینید.

pendingOwner

boolean

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

inheritedPermissionsDisabled

boolean

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

روش ها

create

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

delete

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

get

 با شناسه مجوز می گیرد.

list

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

update

 یک مجوز را با معنای پچ به روز می کند.