REST Resource: permissions

Recurso: permissão

Uma permissão para um arquivo. Uma permissão concede a um usuário, grupo, domínio ou ao mundo acesso a um arquivo ou a uma hierarquia de pastas.

Alguns métodos de recurso, como permissions.update, exigem um permissionId. Use o método permissions.list para recuperar o ID de um arquivo, uma pasta ou um drive compartilhado.

Representação 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
}
Campos
id

string

Apenas saída. O ID dessa permissão. Esse é um identificador exclusivo do beneficiário e é publicado nos recursos do usuário como permissionId. Os IDs precisam ser tratados como valores opacos.
displayName

string

Apenas saída. Os "bonitos" nome do valor da permissão. Esta é uma lista de exemplos para cada tipo de permissão:

  • user: nome completo do usuário, conforme definido na Conta do Google, como "João Silva".
  • group: nome do Grupo do Google, como "Administradores da Empresa".
  • domain: nome de domínio de string, como "thecompany.com".
  • anyone: não há displayName presente.
type

string

O tipo de beneficiário. Os valores válidos são:

  • user
  • group
  • domain
  • anyone

Ao criar uma permissão, se type for user ou group, forneça um emailAddress para o usuário ou grupo. Quando type for domain, você precisará fornecer um domain. Não são necessárias informações extras para um tipo anyone.
kind

string

Apenas saída. Identifica o tipo de recurso. Valor: a string fixa "drive#permission".
permissionDetails[]

object

Apenas saída. Detalhes se as permissões neste item do drive compartilhado são herdadas ou diretamente neste item. Este é um campo somente para saída presente apenas nos itens dos drives compartilhados.
permissionDetails[].permissionType

string

Apenas saída. O tipo de permissão deste usuário. Embora novos valores possam ser adicionados no futuro, os seguintes são possíveis no momento:

  • file
  • member
permissionDetails[].inheritedFrom

string

Apenas saída. O ID do item do qual essa permissão é herdada. Este é um campo somente para saída.
permissionDetails[].role

string

Apenas saída. A função principal desse usuário. No momento, é possível adicionar novos valores:

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

boolean

Apenas saída. Indica se essa permissão é herdada. Esse campo é sempre preenchido. Este é um campo somente para saída.
emailAddress

string

O endereço de e-mail do usuário ou grupo a que essa permissão se refere.
role

string

O papel concedido pela permissão. Embora novos valores possam ser compatíveis no futuro, os seguintes valores são permitidos atualmente:

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

boolean

Define se a permissão permite que o arquivo seja descoberto na pesquisa. Isso só é aplicável às permissões do tipo domain ou anyone.
domain

string

O domínio a que esta permissão se refere.
expirationTime

string

A hora em que esta permissão expira (data-hora RFC 3339). Os tempos de expiração têm as seguintes restrições:

  • Elas só podem ser definidas com base nas permissões do usuário e do grupo.
  • O horário precisa estar no futuro.
  • O horário não pode ser mais de um ano à frente.
teamDrivePermissionDetails[]
(deprecated)

object

Apenas saída. Obsoleto: somente saída. Use permissionDetails
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Obsoleto: somente saída. Use permissionDetails/permissionType
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Obsoleto: somente saída. Use permissionDetails/inheritedFrom
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Obsoleto: somente saída. Use permissionDetails/role
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Obsoleto: somente saída. Use permissionDetails/inherited
deleted

boolean

Apenas saída. Indica se a conta associada a essa permissão foi excluída. Este campo só diz respeito às permissões do usuário e do grupo.
view

string

Indica a visualização para essa permissão. Preenchido apenas para permissões que pertencem a uma vista. 'publicado' é o único valor compatível.
pendingOwner

boolean

Indica se a conta associada a essa permissão é um proprietário pendente. Preenchido apenas com permissões do tipo user para arquivos que não estão em um drive compartilhado.

Métodos

create

 Cria uma permissão para um arquivo ou drive compartilhado.

delete

 Exclui uma permissão.

get

 Recebe uma permissão por ID.

list

 Lista as permissões de um arquivo ou drive compartilhado.

update

 Atualiza uma permissão com semântica de patch.