REST Resource: permissions

منبع: مجوز

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

برخی از روش‌های منبع (مانند permissions.update ) به یک permissionId نیاز دارند. از روش permissions.list برای بازیابی شناسه فایل، پوشه یا درایو مشترک استفاده کنید.

نمایندگی JSON 
{
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
فیلدها
id

string

شناسه کاربری که این مجوز به آن اشاره دارد و با permissionId در منابع About و Files یکسان است. هنگام ایجاد یک درخواست drive.permissions.insert ، دقیقاً یکی از فیلدهای id یا value باید مشخص شود، مگر اینکه نوع مجوز anyone باشد، در این صورت هم id و value نادیده گرفته می شوند.

name

string

فقط خروجی نام این مجوز.

type

string

نوع حساب مقادیر مجاز عبارتند از:

  • user
  • group
  • domain
  • anyone
role

string

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

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

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

authKey
(deprecated)

string

فقط خروجی منسوخ شده است.

value

string

آدرس ایمیل یا نام دامنه برای نهاد. این در هنگام درج ها استفاده می شود و در پاسخ ها پر نمی شود. هنگام ایجاد یک درخواست drive.permissions.insert ، دقیقاً یکی از فیلدهای id یا value باید مشخص شود، مگر اینکه نوع مجوز anyone باشد، در این صورت هم id و value نادیده گرفته می شوند.

kind

string

فقط خروجی این همیشه drive#permission است.

emailAddress

string

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

domain

string

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

etag

string

فقط خروجی ETag مجوز.

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • reader
permissionDetails[].additionalRoles[]

string

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

permissionDetails[].inheritedFrom

string

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

permissionDetails[].inherited

boolean

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

expirationDate

string

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

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

object

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

teamDrivePermissionDetails[]
(deprecated) .teamDrivePermissionType
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated) .role
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated) .additionalRoles[]
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated) .inheritedFrom
(deprecated)

string

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

teamDrivePermissionDetails[]
(deprecated) .inherited
(deprecated)

boolean

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

deleted

boolean

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

view

string

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

pendingOwner

boolean

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

روش ها

delete

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

get

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

getIdForEmail

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

insert

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

list

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

patch

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

update

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