REST Resource: permissions

Ресурс: Разрешение

Разрешение для файла. Разрешение предоставляет пользователю, группе, домену или всему миру доступ к иерархии файлов или папок.

Некоторые методы ресурсов (например, permissions.update ) требуют permissionId . Используйте метод permissions.list для получения идентификатора файла, папки или общего диска.

JSON-представление 
{
  "additionalRoles": [
    string
  ],
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "expirationDate": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Поля
additionalRoles[]

string

Дополнительные роли для этого пользователя. В настоящее время разрешен только commenter , хотя в будущем может поддерживаться больше.

permissionDetails[]

object

Только вывод. Подробности о том, унаследованы ли разрешения на этот элемент или напрямую на этот элемент.

permissionDetails[].permissionType

string

Только вывод. Тип разрешения для этого пользователя. Хотя в будущем могут быть добавлены новые значения, в настоящее время возможны следующие:

  • file
  • member
permissionDetails[].role

string

Только вывод. Основная роль для этого пользователя. Хотя в будущем могут быть добавлены новые значения, в настоящее время возможны следующие:

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

string

Только вывод. Дополнительные роли для этого пользователя. В настоящее время возможен только commenter , хотя в будущем может поддерживаться больше.

permissionDetails[].inheritedFrom

string

Только вывод. Идентификатор элемента, от которого унаследовано это разрешение. Заполняется только для элементов на общих дисках.

permissionDetails[].inherited

boolean

Только вывод. Наследуется ли это разрешение. Это поле всегда заполнено.

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 .

id

string

Идентификатор пользователя, на которого ссылается это разрешение, и он идентичен permissionId в ресурсах About и Files. При выполнении запроса drive.permissions.insert необходимо указать только одно из полей id или value , если только тип разрешения не anyone , в этом случае и id и value игнорируются.

name

string

Только вывод. Имя для этого разрешения.

type

string

Тип учетной записи. Допустимые значения:

  • user
  • group
  • domain
  • anyone
role

string

Основная роль для этого пользователя. Хотя в будущем могут поддерживаться новые значения, в настоящее время разрешены следующие:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
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 разрешения.

expirationDate

string

Время истечения срока действия этого разрешения (дата-время RFC 3339). Даты истечения срока имеют следующие ограничения:

  • Их можно устанавливать только на уровне разрешений пользователя и группы.
  • Дата должна быть в будущем.
  • Дата не может быть позже, чем через год.
deleted

boolean

Только вывод. Была ли удалена учетная запись, связанная с этим разрешением. Это поле относится только к разрешениям пользователя и группы.

view

string

Указывает вид для этого разрешения. Заполняется только для разрешений, которые принадлежат к виду.

published

и

metadata

являются единственными поддерживаемыми значениями.

  • published

    : Роль разрешения — published_reader.

  • metadata

    : Элемент виден только в представлении метаданных, поскольку элемент имеет ограниченный доступ, а область действия имеет по крайней мере доступ на чтение к родительскому элементу. Примечание:

    metadata

    В настоящее время просмотр поддерживается только для папок.

pendingOwner

boolean

Является ли учетная запись, связанная с этим разрешением, ожидающим владельца. Заполняется только для разрешений типа user для файлов, которые не находятся на общем диске.

inheritedPermissionsDisabled

boolean

Если установлено значение true, доступ к элементу могут получить только организаторы, владельцы и пользователи с разрешениями, добавленными непосредственно к элементу.

Методы

delete

 Удаляет разрешение для файла или общего диска.

get

 Получает разрешение по идентификатору.

getIdForEmail

 Возвращает идентификатор разрешения для адреса электронной почты.

insert

 Вставляет разрешение для файла или общего диска.

list

 Выводит список разрешений файла или общего диска.

patch

 Обновляет разрешение, используя семантику исправления.

update

 Обновляет разрешение.