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,
  "inheritedPermissionsDisabled": boolean
}
فیلدها
id

string

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

display Name

string

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

  • user - نام کامل کاربر، همانطور که برای حساب Google آنها تعریف شده است، مانند "Joe Smith."
  • 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" .

permission Details[]

object

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

permission Details[]. permission Type

string

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

  • file
  • member
permission Details[]. inherited From

string

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

permission Details[]. role

string

فقط خروجی نقش اصلی برای این کاربر. در حالی که ممکن است مقادیر جدیدی در آینده اضافه شوند، موارد زیر در حال حاضر امکان پذیر است:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permission Details[]. inherited

boolean

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

email Address

string

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

role

string

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

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
allow File Discovery

boolean

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

domain

string

دامنه ای که این مجوز به آن اشاره دارد.

expiration Time

string

زمانی که این مجوز منقضی می شود (RFC 3339 date-time). زمان انقضا دارای محدودیت های زیر است:

  • آنها را فقط می توان روی مجوزهای کاربر و گروه تنظیم کرد.
  • زمان باید در آینده باشد.
  • زمان در آینده نمی تواند بیش از یک سال باشد.
teamDrivePermissionDetails[]
(deprecated)

object

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

teamDrivePermissionDetails[]
(deprecated) . team Drive Permission Type
(deprecated)

string

منسوخ شده: فقط خروجی. به جای آن از permissionDetails/permissionType استفاده کنید.

teamDrivePermissionDetails[]
(deprecated) . inherited From
(deprecated)

string

منسوخ شده: فقط خروجی. به جای آن از permissionDetails/inheritedFrom استفاده کنید.

teamDrivePermissionDetails[]
(deprecated) . role
(deprecated)

string

منسوخ شده: فقط خروجی. به جای آن از permissionDetails/role استفاده کنید.

teamDrivePermissionDetails[]
(deprecated) . inherited
(deprecated)

boolean

منسوخ شده: فقط خروجی. به جای آن از permissionDetails/inherited استفاده کنید.

deleted

boolean

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

view

string

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

published

و

metadata

تنها مقادیر پشتیبانی شده هستند.

  • published

    : نقش مجوز منتشر شده_خواننده است.

  • metadata

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

    metadata

    view در حال حاضر فقط در پوشه ها پشتیبانی می شود.

pending Owner

boolean

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

inherited Permissions Disabled

boolean

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

روش ها

create

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

delete

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

get

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

list

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

update

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