Escolher escopos da API Directory

Este documento contém informações de autorização e autenticação específicas da API Directory. 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 Directory

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 acessados 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.

A API Directory oferece suporte aos seguintes escopos:

Escopos para dispositivos Significado
https://www.googleapis.com/auth/admin.directory.device.chromeos Escopo global para acesso a todas as operações do dispositivo Chrome.
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly Escopo para recuperar apenas dispositivos Chrome.
https://www.googleapis.com/auth/admin.directory.device.mobile Escopo global para acesso a todas as operações de dispositivos móveis.
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly Escopo para recuperar apenas o dispositivo móvel
https://www.googleapis.com/auth/admin.directory.device.mobile.action Escopo para tarefas que realizam uma ação em um dispositivo móvel.
Escopos para grupos, alias de grupos e membros de grupos Significado
https://www.googleapis.com/auth/admin.directory.group.member Escopo para acesso a todas as funções de membro do grupo e operações de informações.
https://www.googleapis.com/auth/admin.directory.group.member.readonly Escopo para recuperar apenas funções e informações dos membros do grupo.
https://www.googleapis.com/auth/admin.directory.group Escopo global para acesso a todas as operações do grupo, incluindo membros e aliases.
https://www.googleapis.com/auth/admin.directory.group.readonly Escopo para recuperar apenas informações de grupo, alias de grupo e membro.
Escopos das unidades organizacionais Significado
https://www.googleapis.com/auth/admin.directory.orgunit Escopo global para acesso a todas as operações da unidade organizacional.
https://www.googleapis.com/auth/admin.directory.orgunit.readonly Escopo para recuperar apenas unidades organizacionais.
Escopos para usuários e aliases de usuários Significado
https://www.googleapis.com/auth/admin.directory.user Escopo global para acesso a todas as operações de usuário e alias de usuário.
https://www.googleapis.com/auth/admin.directory.user.readonly Escopo para recuperar apenas usuários ou aliases de usuários.
https://www.googleapis.com/auth/admin.directory.user.alias Escopo para acesso a todas as operações de alias de usuário.
https://www.googleapis.com/auth/admin.directory.user.alias.readonly Escopo para recuperar apenas os aliases de usuário.
Escopos para recursos de segurança do usuário Significado
https://www.googleapis.com/auth/admin.directory.user.security Escopo para acesso a todas as operações de senha específica do aplicativo, token OAuth e código de verificação.
Escopos para o gerenciamento de funções Significado
https://www.googleapis.com/auth/admin.directory.rolemanagement Escopo para todas as operações de gerenciamento de papéis, incluindo a criação de papéis e atribuições de papéis.
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly Escopo para receber e listar funções, privilégios e atribuições de função.
Escopos para esquemas de usuário personalizados Significado
https://www.googleapis.com/auth/admin.directory.userschema Escopo para acesso a todas as operações personalizadas do esquema do usuário.
https://www.googleapis.com/auth/admin.directory.userschema.readonly Escopo para recuperar apenas esquemas de usuário personalizados.
Escopos para clientes Significado
https://www.googleapis.com/auth/admin.directory.customer Escopo de acesso a todas as operações do cliente.
https://www.googleapis.com/auth/admin.directory.customer.readonly Escopo para recuperar apenas clientes.
Escopos para domínios Significado
https://www.googleapis.com/auth/admin.directory.domain Escopo para acesso a todas as operações do domínio.
https://www.googleapis.com/auth/admin.directory.domain.readonly Escopo para apenas recuperar domínios.
Escopos para recursos da Agenda Significado
https://www.googleapis.com/auth/admin.directory.resource.calendar Escopo para acesso a todas as operações de recursos da Agenda.
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly Escopo para recuperar apenas recursos da agenda.