REST Resource: permissions

資源:權限

檔案的權限。使用者、群組、網域或全球都能存取檔案或資料夾的階層。

部分資源方法 (例如 permissions.update) 需要 permissionId。使用 permissions.list 方法擷取檔案、資料夾或共用雲端硬碟的 ID。

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

這項權限參照的使用者 ID,與「關於」和「檔案」資源中的 permissionId 相同。建立 drive.permissions.insert 要求時,除非權限類型為 anyone,否則必須指定 idvalue 其中之一。在這種情況下,系統會忽略 idvalue

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 要求時,除非權限類型為 anyone,否則必須指定 idvalue 其中之一。在這種情況下,系統會忽略 idvalue

kind

string

僅供輸出。一律為 drive#permission

emailAddress

string

僅供輸出。這個權限參照的使用者或群組電子郵件地址。這是僅供輸出的欄位,會在權限類型為 usergroup 時顯示。

domain

string

僅供輸出。這項權限參照的實體網域名稱。這是僅供輸出的欄位,會在權限類型為 usergroupdomain 時出現。

etag

string

僅供輸出。權限的 ETag。

permissionDetails[]

object

僅供輸出。詳細說明這個共用雲端硬碟項目的權限是沿用設定,還是直接套用至這個項目。這個僅輸出欄位,僅適用於共用雲端硬碟項目。

permissionDetails[].permissionType

string

僅供輸出。這位使用者的權限類型,雖然日後可能會加入新值,目前還有下列幾種:

  • file
  • member
permissionDetails[].role

string

僅供輸出。這位使用者的主要角色,雖然日後可能會加入新值,目前還有下列幾種:

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

string

僅供輸出。這位使用者的其他角色。目前只支援 commenter,但日後可能會支援更多。

permissionDetails[].inheritedFrom

string

僅供輸出。繼承這項權限的項目 ID。這是一個僅限輸出的欄位。

permissionDetails[].inherited

boolean

僅供輸出。是否沿用這項權限。系統會一律在這個欄位填入資料。這是一個僅限輸出的欄位。

expirationDate

string

這項權限的效期 (RFC 3339 日期時間)。到期日具有以下限制:

  • 只能針對使用者和群組權限設定這類權限
  • 日期必須是未來的日期
  • 日期不得晚於未來一年
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

指出這項權限的檢視畫面。只會針對屬於資料檢視的權限填入資料。published 是唯一支援的值。

pendingOwner

boolean

與這項權限連結的帳戶是否為待處理擁有者。僅針對非共用雲端硬碟中的檔案填入 user 類型權限。

方法

delete

從檔案或共用雲端硬碟刪除權限。

get

根據 ID 取得權限。

getIdForEmail

傳回電子郵件地址的權限 ID。

insert

插入檔案或共用雲端硬碟的權限。

list

列出檔案或共用雲端硬碟的權限。

patch

使用 patch 語意更新權限

update

更新權限。