REST Resource: permissions

资源:权限

文件的权限。权限可向用户、群组、网域或所有人授予对文件或文件夹层次结构的访问权限。

默认情况下,权限请求仅返回部分字段。系统始终会返回权限类型、ID、类型和角色。如需检索特定字段,请参阅 https://developers.google.com/drive/api/guides/fields-parameter。

某些资源方法(例如 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 - 用户的全名(如“Joe Smith”)(针对其 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 日期时间)。失效时间存在以下限制:

  • 只能对用户和群组权限设置这些属性。
  • 时间必须是将来的时间。
  • 时间不得超过未来 1 年。
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

使用补丁语义更新权限。