REST Resource: permissions

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

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

По умолчанию запросы на разрешения возвращают только подмножество полей. Всегда возвращаются kind разрешения, ID , type и role . Чтобы получить определённые поля, см. раздел Возврат определённых полей .

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

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
}
Поля
permissionDetails[]

object

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

permissionDetails[].permissionType

string

Только вывод. Тип разрешения для этого пользователя. Поддерживаемые значения:

  • file
  • member
permissionDetails[].inheritedFrom

string

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

permissionDetails[].role

string

Только вывод. Основная роль для этого пользователя. Поддерживаемые значения:

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

Более подробную информацию см. в разделе Роли и разрешения .

permissionDetails[].inherited

boolean

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

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 .

id

string

Только вывод. Идентификатор данного разрешения. Это уникальный идентификатор получателя, который публикуется в ресурсе User как permissionId . Идентификаторы следует рассматривать как непрозрачные значения.

displayName

string

Только вывод. «Красивое» название значения разрешения. Ниже приведён список примеров для каждого типа разрешения:

  • user — полное имя пользователя, как определено в его учетной записи Google, например, «Дана А.».
  • group — название группы Google, например «Администраторы компании».
  • domain - строковое доменное имя, например «cymbalgroup.com».
  • anyone - displayName отсутствует.
type

string

Тип получателя гранта. Поддерживаемые значения:

  • user
  • group
  • domain
  • anyone

При создании разрешения, если type — user или group , необходимо указать адрес emailAddress пользователя или группы. Если type — domain , необходимо указать domain . Если type — anyone , дополнительная информация не требуется.

kind

string

Только вывод. Определяет тип ресурса. Значение: фиксированная строка "drive#permission" .

emailAddress

string

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

role

string

Роль, предоставляемая этим разрешением. Поддерживаемые значения:

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

Более подробную информацию см. в разделе Роли и разрешения .

allowFileDiscovery

boolean

Позволяет ли разрешение обнаруживать файл через поиск. Это применимо только к разрешениям типа domain или anyone .

domain

string

Домен, к которому относится это разрешение.

expirationTime

string

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

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

boolean

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

view

string

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

Поддерживаются только published значения и metadata :

  • published : Роль разрешения — publishedReader .
  • metadata : элемент виден только в представлении metadata , поскольку у него ограниченный доступ, а область действия имеет как минимум право на чтение родительского элемента. Представление metadata поддерживается только для папок.

Более подробную информацию смотрите в разделе «Взгляды» .

pendingOwner

boolean

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

inheritedPermissionsDisabled

boolean

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

Методы

create

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

delete

 Удаляет разрешение.

get

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

list

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

update

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