Escolher escopos da API Google Drive Labels

Este documento contém informações de autorização e autenticação específicas da API Drive Labels. Antes de ler este documento, leia as informações gerais de autenticação e autorização do Google Workspace em Saiba mais sobre autenticação e autorização.

Configurar o OAuth 2.0 para autorização

Configurar a tela de consentimento do OAuth e escolher escopos para definir quais informações são exibidas para usuários e revisores de apps e registrar seu app para poder publicá-lo mais tarde.

Escopos da API Google Drive Labels

Para definir o nível de acesso concedido ao app, é necessário identificar e declarar os escopos de autorização. Um escopo de autorização é uma string de URI OAuth 2.0 que contém o nome do app do Google Workspace, o tipo de dados que ele acessa e o nível de acesso. Os escopos são as solicitações do app para trabalhar com dados do Google Workspace, incluindo dados da Conta do Google dos usuários.

Quando o app é instalado, o usuário precisa validar os escopos usados por ele. Geralmente, escolha o escopo mais focado possível e evite solicitar escopos que o app não exige. Os usuários concedem acesso mais fácil a escopos limitados e claramente descritos.

Sempre que possível, recomendamos o uso de escopos não sensíveis, porque eles concedem escopo de acesso por arquivo e restringem o acesso a funcionalidades específicas necessárias por um app.

Os seguintes escopos do OAuth 2.0 podem ser usados para ler, pesquisar e modificar os metadados de rótulos aplicados aos itens do Drive:

Escopo Significado
  • https://www.googleapis.com/auth/drive
  • https://www.googleapis.com/auth/drive.file
  • https://www.googleapis.com/auth/drive.metadata
Ler, pesquisar e modificar metadados de marcadores aplicados a itens do Drive.
  • https://www.googleapis.com/auth/drive.readonly
  • https://www.googleapis.com/auth/drive.metadata.readonly
Ler e pesquisar metadados de marcadores aplicados a itens do Drive autorizados para o aplicativo.

Para mais informações, consulte Escopos do OAuth 2.0 da API Drive e Autorização específica da API Drive.

Escopos para rótulos

Os seguintes escopos OAuth podem ser usados para conferir e gerenciar rótulos:

Escopo Significado
https://www.googleapis.com/auth/drive.labels Acessar, usar e gerenciar marcadores do Drive.
  • Esse escopo permite o acesso do usuário e é necessário para operações de gravação quando use_admin_access não está definido.
  • As operações de gravação com esse escopo são válidas para rótulos com o tipo de rótulo SHARED.
https://www.googleapis.com/auth/drive.labels.readonly Acessar e usar marcadores do Drive.
  • Esse escopo permite o acesso do usuário e é necessário para operações de leitura quando use_admin_access não está definido.
https://www.googleapis.com/auth/drive.admin.labels Acessar, editar, criar e excluir todos os marcadores do Drive na sua organização, além de conferir as políticas de administração relacionadas a eles.
  • Esse escopo permite o acesso de administrador e é necessário para operações de gravação quando use_admin_access está definido. Esse escopo também concede acesso de leitura.
  • As operações de gravação com esse escopo são válidas para rótulos com o tipo de rótulo SHARED ou ADMIN.
https://www.googleapis.com/auth/drive.admin.labels.readonly Acesse todos os marcadores do Drive e as políticas de administração relacionadas a eles na sua organização.
  • Esse escopo permite o acesso de administrador e é necessário para operações de leitura quando use_admin_access está definido.

Acesso de administrador

Para gerenciar rótulos ADMIN, você precisa especificar:

  • useAdminAccess é true para usar as credenciais de administrador do usuário.
  • Administradores de conta com o privilégio Gerenciar marcadores.

useAdminAccess

Os administradores precisam definir o parâmetro useAdminAccess para invocar os privilégios de administrador. A configuração useAdminAccess permite a visualização e a edição de qualquer marcador pertencente a um cliente. Isso inclui rótulos ADMIN e SHARED.

Quando useAdminAccess não está definido, as solicitações de gravação são permitidas apenas para rótulos com um SHARED label type e para usuários com a função EDITOR adequada para esse rótulo.

Para mais informações, consulte Criar credenciais de acesso.