REST Resource: permissions

Recurso: permissão

Uma permissão para um arquivo. Uma permissão concede a um usuário, grupo, domínio ou mundo 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 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. O nome "bem" do valor da permissão. Veja a seguir 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 da Silva".
  • group: nome do Grupo do Google, como "Administradores da empresa".
  • domain: nome de domínio da string, como "thecompany.com".
  • anyone - nenhum displayName está presente.
type

string

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

  • user
  • group
  • domain
  • anyone

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

kind

string

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

permissionDetails[]

object

Apenas saída. Mostra se as permissões neste item do drive compartilhado são herdadas ou estão diretamente nele. Este é um campo de saída apenas para itens do drive compartilhado.

permissionDetails[].permissionType

string

Apenas saída. O tipo de permissão para este usuário. Embora novos valores possam ser adicionados no futuro, é possível fazer o seguinte:

  • file
  • member
permissionDetails[].inheritedFrom

string

Apenas saída. Código do item do qual esta permissão é herdada. Este é um campo somente de saída.

permissionDetails[].role

string

Apenas saída. A função principal deste usuário. Embora novos valores possam ser adicionados no futuro, é possível fazer o seguinte:

  • 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 de saída.

emailAddress

string

O endereço de e-mail do usuário ou grupo ao qual esta permissão se refere.

role

string

O papel concedido por essa permissão. Embora novos valores possam ser suportados no futuro, os seguintes itens são permitidos:

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

boolean

Indica se a permissão permite que o arquivo seja descoberto na pesquisa. Isso se aplica apenas a permissões do tipo domain ou anyone.

domain

string

O domínio ao qual esta permissão se refere.

expirationTime

string

A hora em que esta permissão expirará (data e hora RFC 3339). Os prazos de validade têm as seguintes restrições:

  • Eles só podem ser definidos com permissões de usuário e grupo.
  • A hora precisa estar no futuro.
  • O tempo não pode ser superior a um ano no futuro.
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 refere-se apenas 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 visualização. "publicado" é o único valor aceito.

pendingOwner

boolean

Se a conta associada a esta permissão é um proprietário pendente. Preenchido apenas para permissões do tipo user em 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.