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.
Por padrão, as solicitações de permissões retornam apenas um subconjunto de campos. O tipo, o ID, o tipo e a função da permissão são sempre retornados. Para recuperar campos específicos, consulte https://developers.google.com/drive/api/guides/fields-parameter.
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 |
---|
{ "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 |
Apenas saída. O ID dessa permissão. É um identificador exclusivo do beneficiário e é publicado nos recursos do usuário como |
displayName |
Apenas saída. O nome "bonito" do valor da permissão. Confira a seguir uma lista de exemplos para cada tipo de permissão:
|
type |
O tipo de beneficiário. Os valores válidos são:
Ao criar uma permissão, se |
kind |
Apenas saída. Identifica o tipo de recurso. Valor: a string fixa |
permissionDetails[] |
Apenas saída. Detalhes sobre se as permissões no item do drive compartilhado são herdadas ou estão diretamente no item. Este é um campo somente saída que só aparece para itens de drive compartilhado. |
permissionDetails[].permissionType |
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:
|
permissionDetails[].inheritedFrom |
Apenas saída. O ID do item de onde essa permissão é herdada. Este é um campo somente saída. |
permissionDetails[].role |
Apenas saída. A função principal do usuário. Novos valores podem ser adicionados no futuro, mas atualmente é possível fazer o seguinte:
|
permissionDetails[].inherited |
Apenas saída. Se essa permissão é herdada. Esse campo é sempre preenchido. Este é um campo somente saída. |
photoLink |
Apenas saída. Um link para a foto do perfil do usuário, se disponível. |
emailAddress |
O endereço de e-mail do usuário ou grupo a que esta permissão se refere. |
role |
O papel concedido pela permissão. Embora novos valores possam ser aceitos no futuro, os seguintes são permitidos no momento:
|
allowFileDiscovery |
Define se a permissão permite que o arquivo seja descoberto pela pesquisa. Isso é aplicável apenas para permissões do tipo |
domain |
O domínio a que esta permissão se refere. |
expirationTime |
O horário de expiração da permissão (data e hora RFC 3339). Os tempos de expiração têm as seguintes restrições:
|
teamDrivePermissionDetails[] |
Apenas saída. Descontinuado: somente saída. Use |
teamDrivePermissionDetails[] |
Descontinuado: somente saída. Use |
teamDrivePermissionDetails[] |
Descontinuado: somente saída. Use |
teamDrivePermissionDetails[] |
Descontinuado: somente saída. Use |
teamDrivePermissionDetails[] |
Descontinuado: somente saída. Use |
deleted |
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 |
Indica a visualização para essa permissão. Preenchido apenas para permissões que pertencem a uma visualização. "publicado" é o único valor aceito. |
pendingOwner |
Se a conta associada a essa permissão é um proprietário pendente. Só é preenchido para permissões do tipo |
Métodos |
|
---|---|
|
Cria uma permissão para um arquivo ou drive compartilhado. |
|
Exclui uma permissão. |
|
Recebe uma permissão por ID. |
|
Lista as permissões de um arquivo ou drive compartilhado. |
|
Atualiza uma permissão com semântica de patch. |