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 - 用户的全名(针对其 Google 帐号定义),例如“张三”。
  • group - Google 群组的名称,例如“公司管理员”。
  • domain - 字符串域名,例如“thecompany.com”。
  • anyone - 不存在 displayName
type

string

受助人的类型。有效值包括:

  • user
  • group
  • domain
  • anyone

创建权限时,如果 typeusergroup,您必须为用户或群组提供 emailAddress。当 typedomain 时,您必须提供 domainanyone 类型不需要额外信息。

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

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

pendingOwner

boolean

与此权限关联的帐号是否是受让所有者。仅当文件的 user 类型权限不在共享云端硬盘中时,此字段才会显示内容。

方法

create

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

delete

删除权限。

get

根据 ID 获取权限。

list

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

update

使用补丁语义更新权限。