REST Resource: permissions

资源：权限

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

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

JSON 表示法 
{
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
字段
id

string

此权限所引用的用户的 ID，与“关于”和“文件”资源中的 permissionId 相同。发出 drive.permissions.insert 请求时，必须指定 id 或 value 字段之一，除非权限类型为 anyone，在这种情况下，系统会忽略 id 和 value。
name

string

仅限输出。此权限的名称。
type

string

账号类型。允许的值有：

  • user
  • group
  • domain
  • anyone
role

string

此用户的主要角色。虽然未来可能会支持新值，但目前允许使用以下值：

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

此用户的其他角色。目前仅允许使用 commenter，但未来可能会支持更多类型。
authKey
(deprecated)

string

仅限输出。已弃用。
value

string

实体的电子邮件地址或域名。此字段在插入期间使用，不会在响应中填充。发出 drive.permissions.insert 请求时，必须指定 id 或 value 字段之一，除非权限类型为 anyone，在这种情况下，系统会忽略 id 和 value。
kind

string

仅限输出。此值始终为 drive#permission。
emailAddress

string

仅限输出。此权限所引用的用户或群组的电子邮件地址。此字段仅用于输出，当权限类型为 user 或 group 时才会显示。
domain

string

仅限输出。此权限所引用的实体的域名。这是一个仅限输出的字段，当权限类型为 user、group 或 domain 时才会显示。
etag

string

仅限输出。权限的 ETag。
permissionDetails[]

object

仅限输出。详细说明此项的权限是继承的还是直接在此项上。
permissionDetails[].permissionType

string

仅限输出。此用户的权限类型。虽然未来可能会添加新值，但目前可能的值如下：

  • file
  • member
permissionDetails[].role

string

仅限输出。此用户的主要角色。虽然未来可能会添加新值，但目前可能的值如下：

  • organizer
  • fileOrganizer
  • writer
  • reader
permissionDetails[].additionalRoles[]

string

仅限输出。此用户的其他角色。目前只能使用 commenter，但将来可能会支持更多类型。
permissionDetails[].inheritedFrom

string

仅限输出。继承此权限的项的 ID。系统仅会为共享云端硬盘中的内容填充此字段。
permissionDetails[].inherited

boolean

仅限输出。此权限是否可继承。此字段始终会填充。
expirationDate

string

此权限的到期时间（RFC 3339 日期时间）。失效日期存在以下限制：

  • 只能对用户和群组权限设置这些属性
  • 日期必须为未来的日期
  • 日期不得超过一年后的日期
teamDrivePermissionDetails[]
(deprecated)

object

仅限输出。已弃用：请改用 permissionDetails。
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

仅限输出。已弃用：请改用 permissionDetails/permissionType。
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

仅限输出。已弃用：请改用 permissionDetails/role。
teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

仅限输出。已弃用：请改用 permissionDetails/additionalRoles。
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

仅限输出。已弃用：请改用 permissionDetails/inheritedFrom。
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

仅限输出。已弃用：请改用 permissionDetails/inherited。
deleted

boolean

仅限输出。与此权限关联的账号是否已被删除。此字段仅与用户和群组权限相关。
view

string

表示此权限的视图。仅针对视图所属的权限进行填充。

published

和

metadata

是唯一支持的值。

  • published

    ：权限的角色为 published_reader。

  • metadata

    ：由于该项的访问权限受限，并且相应范围对父级至少具有读取权限，因此该项仅对元数据视图可见。注意：

    metadata

    目前仅支持文件夹视图。
pendingOwner

boolean

与此权限关联的账号是否为待处理的所有者。仅针对非共享云端硬盘中的文件的 user 类型权限进行填充。
inheritedPermissionsDisabled

boolean

如果为 true，则只有组织者、所有者和直接对内容添加了权限的用户才能访问该内容。

方法

delete

 从文件或共享云端硬盘中删除权限。

get

 按 ID 获取权限。

getIdForEmail

 返回电子邮件地址的权限 ID。

insert

 为文件或共享云端硬盘插入权限。

list

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

patch

 使用补丁语义更新权限。

update

 更新权限。