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

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

pendingOwner

boolean

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

Методы

create

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

delete

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

get

 Получает разрешение по ID.

list

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

update

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