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
Configure a tela de permissão OAuth e escolha escopos para definir quais informações são mostradas aos usuários e revisores de apps e registre seu app para poder publicá-lo depois.
Escopos da API Directory
Para definir o nível de acesso concedido ao app, é necessário identificar e declarar escopos de autorização. Um escopo de autorização é uma string de URI do OAuth 2.0 que contém o nome do app do Google Workspace, os tipos de dados que ele acessa e o nível de acesso. Os escopos são as solicitações do app para trabalhar com os dados do Google Workspace, incluindo os dados da Conta do Google dos usuários.
Quando o app é instalado, o usuário precisa validar os escopos usados pelo app. Em geral, escolha o escopo mais restrito possível e evite solicitar escopos que não são necessários para o app. Os usuários concedem acesso mais rápido a escopos limitados e claramente descritos.
A API Directory é compatível com os seguintes escopos:
| Escopos para dispositivos | Significado |
|---|---|
https://www.googleapis.com/auth/admin.directory.device.chromeos |
Escopo global para acesso a todas as operações de dispositivos Chrome. |
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly |
Escopo para recuperação apenas de 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 |
Definir o escopo das tarefas que realizam uma ação em um dispositivo móvel. |
| Escopos de grupos, aliases de grupo e participantes de grupos | Significado |
https://www.googleapis.com/auth/admin.directory.group.member |
Escopo de acesso a todas as funções de participantes do grupo e operações de informação. |
https://www.googleapis.com/auth/admin.directory.group.member.readonly |
Escopo para recuperação apenas de funções e informações dos participantes do grupo. |
https://www.googleapis.com/auth/admin.directory.group |
Escopo global para acesso a todas as operações de grupo, incluindo aliases e participantes do grupo. |
https://www.googleapis.com/auth/admin.directory.group.readonly |
Escopo para recuperação apenas de informações do grupo, alias do 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 de unidade organizacional. |
https://www.googleapis.com/auth/admin.directory.orgunit.readonly |
Escopo para recuperação apenas de unidades organizacionais. |
| Escopos de 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 usuários ou aliases de usuários. |
https://www.googleapis.com/auth/admin.directory.user.alias |
Escopo do acesso a todas as operações de alias de usuário. |
https://www.googleapis.com/auth/admin.directory.user.alias.readonly |
Escopo para recuperação apenas de aliases de usuário. |
| Escopos dos recursos de segurança do usuário | Significado |
https://www.googleapis.com/auth/admin.directory.user.security |
Defina o escopo do acesso a todas as operações de senha, token OAuth e código de verificação específicos do aplicativo. |
| Escopos do gerenciamento de funções | Significado |
https://www.googleapis.com/auth/admin.directory.rolemanagement |
Escopo de todas as operações de gerenciamento de funções, incluindo criação de funções e atribuições de funções. |
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 de acesso a todas as operações de esquema de usuário personalizado. |
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 do acesso a todas as operações do cliente. |
https://www.googleapis.com/auth/admin.directory.customer.readonly |
Escopo para recuperação apenas de clientes. |
| Escopos dos domínios | Significado |
https://www.googleapis.com/auth/admin.directory.domain |
Escopo de acesso a todas as operações do domínio. |
https://www.googleapis.com/auth/admin.directory.domain.readonly |
Escopo somente para recuperação de domínios. |
| Escopos dos recursos da agenda | Significado |
https://www.googleapis.com/auth/admin.directory.resource.calendar |
Escopo de acesso a todas as operações de recursos da agenda. |
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly |
Escopo para recuperar apenas os recursos da agenda. |