REST Resource: permissions

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

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

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

Для некоторых методов работы с ресурсами (например, 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,
  "inheritedPermissionsDisabled": boolean
}
Поля
id

string

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

displayName

string

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

  • user — полное имя пользователя, указанное в его учетной записи Google, например, «Dana A.».
  • 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" .

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].inheritedFrom

string

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

permissionDetails[].role

string

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

  • owner
  • 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

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

view

string

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

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

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

Для получения более подробной информации см. раздел «Виды» .

pendingOwner

boolean

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

inheritedPermissionsDisabled

boolean

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

Методы

create

 Создает права доступа для файла или общего диска.

delete

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

get

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

list

 Отображает права доступа к файлу или общему диску.

update

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