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。这是受助人的唯一标识符,以 permissionId 的形式在用户资源中发布。ID 应被视为不透明值。

displayName

string

仅限输出。“漂亮”权限值的名称。以下是每种权限类型的示例列表:

  • user - 用户的全名,如“张三”。
  • 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

指示此权限的视图。仅针对属于视图的权限填充。“已发布”是唯一支持的值。

pendingOwner

boolean

与此权限关联的账号是否为受让所有者。系统只会为不在共享云端硬盘中的文件填充 user 类权限。

方法

create

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

delete

删除权限。

get

根据 ID 获取权限。

list

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

update

使用补丁语义更新权限。