Permissions

Para ver uma lista de métodos desse recurso, consulte o final desta página.

Representações de recursos

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

{
  "kind": "drive#permission",
  "id": string,
  "type": string,
  "emailAddress": string,
  "domain": string,
  "role": string,
  "view": string,
  "allowFileDiscovery": boolean,
  "displayName": string,
  "photoLink": string,
  "expirationTime": datetime,
  "teamDrivePermissionDetails": [
    {
      "teamDrivePermissionType": string,
      "role": string,
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "permissionDetails": [
    {
      "permissionType": string,
      "role": string,
      "inheritedFrom": string,
      "inherited": boolean
    }
  ],
  "deleted": boolean,
  "pendingOwner": boolean
}
Nome da propriedade Valor Descrição Observações
kind string Identifica o tipo de recurso. Valor: a string fixa "drive#permission".
id string O ID desta permissão. Esse identificador é exclusivo para o beneficiário e é publicado nos recursos do usuário como permissionId. Os IDs precisam ser tratados como valores opacos.
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, você vai precisar fornecer um emailAddress para o usuário ou grupo. Quando type for domain, é necessário fornecer um domain. Não há informações extras necessárias para o tipo anyone.		 gravável
emailAddress string É o endereço de e-mail do usuário ou grupo ao qual essa permissão se refere. gravável
domain string O domínio ao qual esta permissão se refere. Atualmente, as seguintes opções são permitidas:
  • O domínio inteiro, como "sua-empresa.com".
  • Um público-alvo, como "ID.audience.googledomains.com".
 gravável
role string O papel concedido pela permissão. Embora novos valores possam ser compatíveis no futuro, os seguintes itens são permitidos:
  • owner
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
 gravável
allowFileDiscovery boolean Indica se a permissão permite que o arquivo seja descoberto na pesquisa. Isso se aplica apenas às permissões do tipo domain ou anyone. gravável
displayName string O nome "bonito" do valor da permissão. Veja uma lista de exemplos para cada tipo de permissão:
  • user: nome completo do usuário, conforme definido para a Conta do Google, como "João Silva".
  • group: nome do Grupo do Google, como "Administradores da empresa".
  • domain – Nome de domínio da string, como "sua-empresa.com".
  • anyone: nenhum displayName está presente.
expirationTime datetime A hora em que essa permissão expira (RFC 3339, data e hora). Os prazos de validade têm as seguintes restrições:
  • Eles não podem ser definidos em itens do drive compartilhado.
  • Eles só podem ser definidos com permissões de usuário e grupo.
  • A hora deve ser uma data futura.
  • O horário não pode ser mais de um ano no futuro.
 gravável
teamDrivePermissionDetails[] list Descontinuado. Use permissionDetails.
teamDrivePermissionDetails[].teamDrivePermissionType string Descontinuado. Use permissionDetails/permissionType.
teamDrivePermissionDetails[].role string Descontinuado. Use permissionDetails/role.
teamDrivePermissionDetails[].inheritedFrom string Descontinuado. Use permissionDetails/inheritedFrom.
teamDrivePermissionDetails[].inherited boolean Descontinuado. Use permissionDetails/inherited.
deleted boolean Indica se a conta associada a esta permissão foi excluída. Este campo pertence apenas a permissões de usuário e grupo.
permissionDetails[] list Mostra se as permissões neste item de drive compartilhado são herdadas ou estão diretamente neste item. Este é um campo somente de saída que está presente apenas nos itens do drive compartilhado.
permissionDetails[].permissionType string O tipo de permissão do usuário. Embora valores novos possam ser adicionados no futuro, os seguintes itens são permitidos no momento:
  • file
  • member
permissionDetails[].role string A função principal deste usuário. Embora novos valores possam ser adicionados no futuro, os seguintes itens são permitidos no momento:
  • organizer
  • fileOrganizer
  • writer
  • commenter
  • reader
permissionDetails[].inheritedFrom string ID do item de que essa permissão é herdada. Este é um campo somente de saída.
permissionDetails[].inherited boolean Indica se a permissão é herdada. Esse campo é sempre preenchido. Este é um campo somente de saída.
view string Indica a visualização dessa permissão. Preenchido apenas para permissões que pertencem a uma visualização. published é o único valor compatível. gravável
pendingOwner boolean Indica se a conta associada a esta permissão tem um proprietário pendente. Preenchido apenas para permissões do tipo user em arquivos que não estão em um drive compartilhado. gravável

Métodos

create
Cria uma permissão para um arquivo ou drive compartilhado. Veja mais informações sobre como criar permissões em Compartilhar arquivos, pastas e drives.
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.