REST Resource: permissions

資源:權限

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

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

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
}
欄位
id

string

僅供輸出。這項權限的 ID。這是授予對象的專屬 ID,並以 permissionId 的形式發布在使用者資源中。ID 應視為不透明值。

displayName

string

僅供輸出。「美化」權限值的名稱。以下列出每種權限類型的範例:

  • user - 使用者在 Google 帳戶中定義的全名,例如「王大明」。
  • group - Google 群組名稱,例如「公司管理員」。
  • domain - 字串網域名稱,例如「thecompany.com」。
  • anyone - 沒有 displayName
type

string

授予對象的類型。有效值如下:

  • user
  • group
  • domain
  • anyone

如果 typeusergroup,當您建立權限時,您必須為使用者或群組提供 emailAddress。當 typedomain 時,您必須提供 domain。您不需要為 anyone 類型提供額外資訊。

kind

string

僅供輸出。標示資源的種類。值:固定字串 "drive#permission"

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

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

permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

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

emailAddress

string

這個權限參照的使用者或群組的電子郵件地址。

role

string

這個權限授予的角色。我們日後可能會支援新的值,但目前允許下列值:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
allowFileDiscovery

boolean

權限是否允許使用者透過搜尋功能找到檔案。這僅適用於 domainanyone 類型的權限。

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

僅供輸出。與這項權限相關聯的帳戶是否已刪除。這個欄位僅適用於使用者和群組權限。

view

string

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

pendingOwner

boolean

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

方法

create

為檔案或共用雲端硬碟建立權限。

delete

刪除權限。

get

根據 ID 取得權限。

list

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

update

使用 patch 語意更新權限