REST Resource: permissions

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

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

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

JSON-представление 
{
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "additionalRoles": [
    string
  ],
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "expirationDate": string,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean
}
Поля
id

string

Идентификатор пользователя, к которому относится это разрешение, идентичен идентификатору permissionId в ресурсах «О программе» и «Файлы». При выполнении запроса drive.permissions.insert необходимо указать ровно одно из полей id или value , если только тип разрешения не имеет anyone , в этом случае и id , и value игнорируются.

name

string

Только вывод. Имя для этого разрешения.

type

string

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

  • user
  • group
  • domain
  • anyone
role

string

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

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
additionalRoles[]

string

Дополнительные роли для этого пользователя. В настоящее время разрешен только commenter , хотя в будущем может поддерживаться и больше комментаторов.

authKey
(deprecated)

string

Только вывод. Устарело.

value

string

Адрес электронной почты или доменное имя организации. Он используется во время вставок и не заполняется в ответах. При выполнении запроса drive.permissions.insert необходимо указать ровно одно из полей id или value , если только тип разрешения не имеет anyone , в этом случае и id , и value игнорируются.

kind

string

Только вывод. Это всегда drive#permission .

emailAddress

string

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

domain

string

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

etag

string

Только вывод. ETag разрешения.

permissionDetails[]

object

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

permissionDetails[].permissionType

string

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

  • file
  • member
permissionDetails[].role

string

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

  • organizer
  • fileOrganizer
  • writer
  • reader
permissionDetails[].additionalRoles[]

string

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

permissionDetails[].inheritedFrom

string

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

permissionDetails[].inherited

boolean

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

expirationDate

string

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

  • Их можно установить только для разрешений пользователя и группы.
  • Дата должна быть в будущем
  • Дата не может быть позже, чем через год.
teamDrivePermissionDetails[]
(deprecated)

object

Только вывод. Устарело: вместо этого используйте permissionDetails .

teamDrivePermissionDetails[]
(deprecated) .teamDrivePermissionType
(deprecated)

string

Только вывод. Устарело: вместо этого используйте permissionDetails/permissionType .

teamDrivePermissionDetails[]
(deprecated) .role
(deprecated)

string

Только вывод. Устарело: вместо этого используйте permissionDetails/role .

teamDrivePermissionDetails[]
(deprecated) .additionalRoles[]
(deprecated)

string

Только вывод. Устарело: вместо этого используйте permissionDetails/additionalRoles .

teamDrivePermissionDetails[]
(deprecated) .inheritedFrom
(deprecated)

string

Только вывод. Устарело: вместо этого используйте permissionDetails/inheritedFrom .

teamDrivePermissionDetails[]
(deprecated) .inherited
(deprecated)

boolean

Только вывод. Устарело: вместо этого используйте permissionDetails/inherited .

deleted

boolean

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

view

string

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

pendingOwner

boolean

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

Методы

delete

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

get

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

getIdForEmail

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

insert

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

list

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

patch

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

update

 Обновляет разрешение.