REST Resource: permissions

资源:Permission

文件的权限。权限授予用户、群组、网域或全局访问文件或文件夹层次结构的权限。

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 帐号所示,例如“Joe Smith”。
  • 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

使用补丁语义更新权限。