REST Resource: permissions

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

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

По умолчанию запросы разрешений возвращают только подмножество полей. Вид разрешения, идентификатор, тип и роль всегда возвращаются. Чтобы получить определенные поля, см. https://developers.google.com/workspace/drive/api/guides/fields-parameter .

Некоторые методы ресурсов (например, 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

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

displayName

string

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

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

string

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

  • user
  • group
  • domain
  • anyone

При создании разрешения, если type — user или group , необходимо указать emailAddress для пользователя или группы. Если type — domain , необходимо указать domain . Для типа 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). Сроки действия имеют следующие ограничения:

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

boolean

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

view

string

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

published

и

metadata

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

  • published

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

  • metadata

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

    metadata

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

pendingOwner

boolean

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

inheritedPermissionsDisabled

boolean

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

Методы

create

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

delete

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

get

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

list

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

update

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