REST Resource: permissions

Tài nguyên: Quyền

Quyền đối với một tệp. Quyền cho phép người dùng, nhóm, miền hoặc mọi người truy cập vào một tệp hoặc hệ thống phân cấp thư mục. Để biết thêm thông tin, hãy xem bài viết Chia sẻ tệp, thư mục và ổ đĩa.

Theo mặc định, các yêu cầu cấp quyền chỉ trả về một nhóm nhỏ các trường. Quyền kind, ID, typerole luôn được trả về. Để truy xuất các trường cụ thể, hãy xem phần Trả về các trường cụ thể.

Một số phương thức tài nguyên (chẳng hạn như permissions.update) yêu cầu có permissionId. Sử dụng phương thức permissions.list để truy xuất mã nhận dạng của một tệp, thư mục hoặc bộ nhớ dùng chung.

Biểu diễn dưới dạng JSON
{
  "permissionDetails": [
    {
      "permissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "inheritedFrom": string,
      "role": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "displayName": string,
  "type": string,
  "kind": string,
  "photoLink": string,
  "emailAddress": string,
  "role": string,
  "allowFileDiscovery": boolean,
  "domain": string,
  "expirationTime": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Trường
permissionDetails[]

object

Chỉ có đầu ra. Thông tin chi tiết về việc quyền đối với mục này được thừa kế hay được cấp trực tiếp cho mục này.

permissionDetails[].permissionType

string

Chỉ có đầu ra. Loại quyền của người dùng này. Các giá trị được hỗ trợ bao gồm:

  • file
  • member
permissionDetails[].inheritedFrom

string

Chỉ có đầu ra. Mã nhận dạng của mục mà quyền này được kế thừa. Trường này chỉ được điền sẵn cho các mục trong bộ nhớ dùng chung.

permissionDetails[].role

string

Chỉ có đầu ra. Vai trò chính của người dùng này. Các giá trị được hỗ trợ bao gồm:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

Để biết thêm thông tin, hãy xem phần Vai trò và quyền.

permissionDetails[].inherited

boolean

Chỉ có đầu ra. Quyền này có được kế thừa hay không. Trường này luôn được điền sẵn. Đây là trường chỉ có đầu ra.

teamDrivePermissionDetails[]
(deprecated)

object

Chỉ có đầu ra. Không dùng nữa: Chỉ có đầu ra. Thay vào đó, hãy sử dụng permissionDetails.

teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Không dùng nữa: Chỉ có đầu ra. Thay vào đó, hãy sử dụng permissionDetails/permissionType.

teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Không dùng nữa: Chỉ có đầu ra. Thay vào đó, hãy sử dụng permissionDetails/inheritedFrom.

teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Không dùng nữa: Chỉ có đầu ra. Thay vào đó, hãy sử dụng permissionDetails/role.

teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Không dùng nữa: Chỉ có đầu ra. Thay vào đó, hãy sử dụng permissionDetails/inherited.

id

string

Chỉ có đầu ra. Mã nhận dạng của quyền này. Đây là giá trị nhận dạng riêng biệt của bên được cấp và được xuất bản trong Tài nguyên người dùng dưới dạng permissionId. Bạn nên coi mã nhận dạng là các giá trị mờ.

displayName

string

Chỉ có đầu ra. Tên "đẹp" của giá trị quyền. Sau đây là danh sách ví dụ cho từng loại quyền:

  • user – Tên đầy đủ của người dùng, theo định nghĩa cho Tài khoản Google của họ, chẳng hạn như "Dana A."
  • group – Tên của Nhóm Google, chẳng hạn như "Quản trị viên công ty".
  • domain – Tên miền dạng chuỗi, chẳng hạn như "cymbalgroup.com".
  • anyone – Không có displayName.
type

string

Loại người được cấp quyền. Các giá trị được hỗ trợ bao gồm:

  • user
  • group
  • domain
  • anyone

Khi tạo một quyền, nếu typeuser hoặc group, bạn phải cung cấp emailAddress cho người dùng hoặc nhóm. Nếu typedomain, bạn phải cung cấp domain. Nếu typeanyone, bạn không cần cung cấp thêm thông tin.

kind

string

Chỉ có đầu ra. Xác định loại tài nguyên này. Giá trị: chuỗi cố định "drive#permission".

emailAddress

string

Địa chỉ email của người dùng hoặc nhóm mà quyền này đề cập đến.

role

string

Vai trò được cấp theo quyền này. Các giá trị được hỗ trợ bao gồm:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader

Để biết thêm thông tin, hãy xem phần Vai trò và quyền.

allowFileDiscovery

boolean

Quyền này có cho phép tìm thấy tệp thông qua tính năng tìm kiếm hay không. Điều này chỉ áp dụng cho các quyền thuộc loại domain hoặc anyone.

domain

string

Miền mà quyền này đề cập đến.

expirationTime

string

Thời điểm quyền này sẽ hết hạn (ngày giờ theo RFC 3339). Thời gian hết hạn có các hạn chế sau:

  • Bạn chỉ có thể đặt thời gian hết hạn cho quyền của người dùng và nhóm.
  • Thời gian phải là thời gian trong tương lai.
  • Thời gian không được quá một năm nữa.
deleted

boolean

Chỉ có đầu ra. Tài khoản được liên kết với quyền này đã bị xoá hay chưa. Trường này chỉ liên quan đến các quyền thuộc loại user hoặc group.

view

string

Cho biết chế độ xem cho quyền này. Chỉ được điền sẵn cho những quyền thuộc một khung hiển thị.

Giá trị duy nhất được hỗ trợ là publishedmetadata:

  • published: Vai trò của quyền là publishedReader.
  • metadata: Mục này chỉ xuất hiện trong chế độ xem metadata vì mục đó có quyền truy cập bị giới hạn và phạm vi có ít nhất quyền đọc đối với thư mục mẹ. Chế độ xem metadata chỉ được hỗ trợ trên thư mục.

Để biết thêm thông tin, hãy xem phần Lượt xem.

pendingOwner

boolean

Tài khoản được liên kết với quyền này có phải là chủ sở hữu đang chờ xử lý hay không. Chỉ được điền sẵn cho các quyền thuộc loại user đối với những tệp không nằm trong bộ nhớ dùng chung.

inheritedPermissionsDisabled

boolean

Khi true, chỉ người tổ chức, chủ sở hữu và người dùng có quyền được thêm trực tiếp vào mục mới có thể truy cập vào mục đó.

Phương thức

create

Tạo quyền cho một tệp hoặc bộ nhớ dùng chung.

delete

Xoá một quyền.

get

Nhận quyền theo mã nhận dạng.

list

Liệt kê các quyền đối với một tệp hoặc bộ nhớ dùng chung.

update

Cập nhật một quyền bằng ngữ nghĩa vá.