REST Resource: permissions

Recurso: permissão

Permissão para um arquivo. A permissão concede a um usuário, grupo, domínio ou ao mundo o 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,
  "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
}
Campos
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 da 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. Novos valores podem ser suportados no futuro, mas os seguintes são permitidos no momento:

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

string

Funções adicionais para esse usuário. No momento, somente commenter é permitido, mas o uso de mais recursos poderá ser oferecido no futuro.
authKey
(deprecated)

string

Apenas saída. Obsoleto.
value

string

Endereço de e-mail ou nome de domínio da entidade. É usado durante 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. É 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 para 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 esta permissão se refere. Este é um campo somente para 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.
permissionDetails[]

object

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

string

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

  • file
  • member
permissionDetails[].role

string

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

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

string

Apenas saída. Funções adicionais para esse usuário. No momento, só é possível usar commenter, mas vamos disponibilizar mais opções no futuro.
permissionDetails[].inheritedFrom

string

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

boolean

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

string

O horário em que essa permissão vai expirar (data-hora RFC 3339). As datas de validade têm as seguintes restrições:

  • Elas só podem ser definidas para permissões de usuário e grupo
  • A data precisa estar no futuro
  • A data não pode ser posterior a um ano no futuro
teamDrivePermissionDetails[]
(deprecated)

object

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

string

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

string

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

string

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

string

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

boolean

Apenas saída. Obsoleto: use permissionDetails/inherited.
deleted

boolean

Apenas saída. Se a conta associada a essa permissão foi excluída. Esse campo só diz respeito a 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 vista. published é o único valor compatível.
pendingOwner

boolean

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

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 semântica de patch.

update

 Atualiza uma permissão.