REST Resource: permissions

Recurso: permissão

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

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

Representação JSON 
{
  "additionalRoles": [
    string
  ],
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "additionalRoles": [
        string
      ],
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "id": string,
  "name": string,
  "type": string,
  "role": string,
  "authKey": string,
  "value": string,
  "kind": string,
  "withLink": boolean,
  "photoLink": string,
  "selfLink": string,
  "emailAddress": string,
  "domain": string,
  "etag": string,
  "expirationDate": string,
  "deleted": boolean,
  "view": string,
  "pendingOwner": boolean,
  "inheritedPermissionsDisabled": boolean
}
Campos
additionalRoles[]

string

Outras funções do usuário. No momento, apenas commenter é permitido, mas mais opções poderão ser aceitas no futuro.
permissionDetails[]

object

Apenas saída. Detalhes sobre se as permissões no item são herdadas ou estão diretamente no item.
permissionDetails[].permissionType

string

Apenas saída. O tipo de permissão do usuário. Novos valores podem ser adicionados no futuro, mas atualmente é possível usar o seguinte:

  • file
  • member
permissionDetails[].role

string

Apenas saída. A função principal do usuário. Novos valores podem ser adicionados no futuro, mas atualmente é possível fazer o seguinte:

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

string

Apenas saída. Outras funções do usuário. No momento, apenas commenter é possível, mas mais recursos poderão ser aceitos no futuro.
permissionDetails[].inheritedFrom

string

Apenas saída. O ID do item de onde essa permissão é herdada. Esse campo só é preenchido para itens em drives compartilhados.
permissionDetails[].inherited

boolean

Apenas saída. Se essa permissão é herdada. Esse campo é sempre preenchido.
teamDrivePermissionDetails[]
(deprecated)

object

Apenas saída. Descontinuado: use permissionDetails.
teamDrivePermissionDetails[]
(deprecated).teamDrivePermissionType
(deprecated)

string

Apenas saída. Descontinuado: use permissionDetails/permissionType.
teamDrivePermissionDetails[]
(deprecated).role
(deprecated)

string

Apenas saída. Descontinuado: use permissionDetails/role.
teamDrivePermissionDetails[]
(deprecated).additionalRoles[]
(deprecated)

string

Apenas saída. Descontinuado: use permissionDetails/additionalRoles.
teamDrivePermissionDetails[]
(deprecated).inheritedFrom
(deprecated)

string

Apenas saída. Descontinuado: use permissionDetails/inheritedFrom.
teamDrivePermissionDetails[]
(deprecated).inherited
(deprecated)

boolean

Apenas saída. Descontinuado: use permissionDetails/inherited.
id

string

O ID do usuário a que essa permissão se refere e é idêntico ao permissionId nos recursos "Sobre" e "Arquivos". Ao fazer uma solicitação drive.permissions.insert, é necessário especificar exatamente um dos campos id ou value, a menos que o tipo de permissão seja anyone. Nesse caso, id e value são ignorados.
name

string

Apenas saída. O nome dessa permissão.
type

string

O tipo de conta. Os valores permitidos são:

  • user
  • group
  • domain
  • anyone
role

string

A função principal do usuário. Embora novos valores possam ser aceitos no futuro, os seguintes são permitidos no momento:

  • owner
  • organizer
  • fileOrganizer
  • writer
  • reader
authKey
(deprecated)

string

Apenas saída. Obsoleto.
value

string

O endereço de e-mail ou nome de domínio da entidade. Ele é usado durante as inserções e não é preenchido nas respostas. Ao fazer uma solicitação drive.permissions.insert, é necessário especificar exatamente um dos campos id ou value, a menos que o tipo de permissão seja anyone. Nesse caso, id e value são ignorados.
kind

string

Apenas saída. Isso é sempre drive#permission.
emailAddress

string

Apenas saída. O endereço de e-mail do usuário ou grupo a que esta permissão se refere. Este é um campo somente de saída que está presente quando o tipo de permissão é user ou group.
domain

string

Apenas saída. O nome de domínio da entidade a que essa permissão se refere. Este é um campo somente de saída que está presente quando o tipo de permissão é user, group ou domain.
etag

string

Apenas saída. A ETag da permissão.
expirationDate

string

O horário de expiração da permissão (data e hora RFC 3339). As datas de validade têm as seguintes restrições:

  • Elas só podem ser definidas nas permissões de usuários e grupos
  • A data precisa estar no futuro
  • A data não pode estar mais de um ano no futuro
deleted

boolean

Apenas saída. Se a conta associada a essa permissão foi excluída. Esse campo se aplica apenas às permissões de usuários e grupos.
view

string

Indica a visualização dessa permissão. Preenchido apenas para permissões que pertencem a uma visualização.

published

e

metadata

são os únicos valores aceitos.

  • published

    : O papel da permissão é published_reader.

  • metadata

    : O item só fica visível para a visualização de metadados porque tem acesso limitado e o escopo tem pelo menos acesso de leitura ao item pai. Observação: o

    metadata

    No momento, a visualização só é compatível com pastas.

pendingOwner

boolean

Se a conta associada a essa permissão é um proprietário pendente. Só é preenchido para permissões do tipo user para arquivos que não estão em um drive compartilhado.
inheritedPermissionsDisabled

boolean

Quando definido como "verdadeiro", apenas organizadores, proprietários e usuários com permissões adicionadas diretamente ao item podem acessá-lo.

Métodos

delete

 Exclui uma permissão de um arquivo ou drive compartilhado.

get

 Recebe uma permissão por ID.

getIdForEmail

 Retorna o ID de permissão de um endereço de e-mail.

insert

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

list

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

patch

 Atualiza uma permissão usando a semântica de patch.

update

 Atualiza uma permissão.