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
}
字段
id

string

此权限所引用的用户的 ID,与“关于”和“文件”资源中的 permissionId 相同。在发出 drive.permissions.insert 请求时,必须仅指定 idvalue 字段中的一个,除非权限类型为 anyone,在这种情况下,idvalue 都会被忽略。

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 请求时,必须仅指定 idvalue 字段中的一个,除非权限类型为 anyone,在这种情况下,idvalue 都会被忽略。

kind

string

仅供输出。始终为 drive#permission

emailAddress

string

仅供输出。此权限所引用的用户或群组的电子邮件地址。此字段是仅限输出的字段,当权限类型为 usergroup 时,就会显示该字段。

domain

string

仅供输出。此权限所引用的实体的域名。这是仅限输出的字段,当权限类型为 usergroupdomain 时会显示该字段。

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 日期时间)。到期日期具有以下限制:

  • 只能针对用户和群组权限进行设置
  • 该日期必须是将来的日期
  • 日期不能超过未来 1 年内的日期
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 是唯一支持的值。

pendingOwner

boolean

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

方法

delete

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

get

根据 ID 获取权限。

getIdForEmail

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

insert

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

list

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

patch

使用补丁语义更新权限。

update

更新权限。