REST Resource: permissions

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

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

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

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

Только вывод. Идентификатор этого разрешения. Это уникальный идентификатор получателя гранта, который публикуется в ресурсах пользователя как 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" .

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

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

permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inherited

boolean

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

emailAddress

string

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

role

string

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

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

boolean

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

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

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