REST Resource: permissions

资源：Permission

文件的权限。权限可授予用户、群组、网域或所有人对文件或文件夹层次结构的访问权限。如需了解详情，请参阅共享文件、文件夹和云端硬盘。

默认情况下，权限请求仅返回部分字段。系统始终会返回权限 kind、ID、type 和 role。如需检索特定字段，请参阅返回特定字段。

某些资源方法（例如 permissions.update）需要 permissionId。使用 permissions.list 方法检索文件、文件夹或共享云端硬盘的 ID。

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

仅限输出。继承此权限的内容的 ID。系统仅会为共享云端硬盘中的内容填充此字段。
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

仅限输出。相应权限的 ID。这是被授权者的唯一标识符，以 permissionId 的形式发布在 User 资源中。ID 应被视为不透明的值。
displayName

string

仅限输出。权限值的“适当”名称。以下是适用于每种权限类型的示例列表：

  • user - 用户的全名（如“Dana A.”）（针对其 Google 账号定义）
  • 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 日期时间）。过期时间具有以下限制：

  • 只能对用户和群组权限设置。
  • 时间必须是未来的时间。
  • 时间不能超过未来一年。
deleted

boolean

仅限输出。与此权限关联的账号是否已被删除。此字段仅适用于 user 或 group 类型的权限。
view

string

表示相应权限的视图。仅针对属于视图的权限填充。

唯一支持的值为 published 和 metadata：

  • published：相应权限的角色为 publishedReader。
  • metadata：相应商品仅在 metadata 视图中可见，因为该商品具有受限访问权限，并且相应范围至少对父级具有读取权限。metadata 视图仅在文件夹中受支持。

如需了解详情，请参阅视图。
pendingOwner

boolean

与相应权限相关联的账号是否为待定所有者。仅针对非共享云端硬盘中类型为 user 的权限填充。
inheritedPermissionsDisabled

boolean

如果设置为 true，则只有组织者、所有者以及直接对相应项目拥有权限的用户可以访问该项目。

方法

create

 为文件或共享云端硬盘创建权限。

delete

 删除权限。

get

 根据 ID 获取权限。

list

 列出文件或共享云端硬盘的权限。

update

 使用补丁语义更新权限。