Este documento contiene información de autorización y autenticación específica de la API de Directory. Antes de leer este documento, asegúrate de leer la información general de autenticación y autorización de Google Workspace en Más información sobre autenticación y autorización.
Configurar OAuth 2.0 para la autorización
Configura la pantalla de consentimiento de OAuth de tu app y elige los alcances para definir qué información se muestra a los usuarios y revisores de la app, y registra tu app para que puedas publicarla más tarde.
Alcances de la API de Directory
Para definir el nivel de acceso otorgado a tu app, debes identificar y declarar los permisos de autorización. Un alcance de autorización es una string de URI de OAuth 2.0 que contiene el nombre de la app de Google Workspace, el tipo de datos a los que accede y el nivel de acceso. Los permisos son las solicitudes de tu app para trabajar con datos de Google Workspace, incluidos los datos de las Cuentas de Google de los usuarios.
Cuando se instala tu app, se le solicita al usuario que valide los permisos que esta usa. En general, debes elegir el alcance más reducido posible y evitar solicitar permisos que la app no requiere. Los usuarios otorgan acceso a permisos limitados y claramente descritos.
La API de Directory admite los siguientes alcances:
| Alcances para los dispositivos | Significado |
|---|---|
https://www.googleapis.com/auth/admin.directory.device.chromeos |
Alcance global para el acceso a todas las operaciones de los dispositivos Chrome. |
https://www.googleapis.com/auth/admin.directory.device.chromeos.readonly |
Permiso para recuperar solo dispositivos Chrome. |
https://www.googleapis.com/auth/admin.directory.device.mobile |
Alcance global para el acceso a todas las operaciones de los dispositivos móviles. |
https://www.googleapis.com/auth/admin.directory.device.mobile.readonly |
Alcance para la recuperación solo del dispositivo móvil |
https://www.googleapis.com/auth/admin.directory.device.mobile.action |
Alcance para las tareas que realizan una acción en un dispositivo móvil. |
| Permisos para grupos, alias de grupos y miembros de grupos | Significado |
https://www.googleapis.com/auth/admin.directory.group.member |
Permiso para acceder a todas las funciones de los miembros del grupo y las operaciones de información. |
https://www.googleapis.com/auth/admin.directory.group.member.readonly |
Permiso para recuperar solo información y funciones de los miembros del grupo. |
https://www.googleapis.com/auth/admin.directory.group |
Permiso global para acceder a todas las operaciones de grupo, incluidos los alias y miembros del grupo. |
https://www.googleapis.com/auth/admin.directory.group.readonly |
Permiso para recuperar solo información de miembros, alias de grupo y grupos. |
| Permisos de las unidades organizativas | Significado |
https://www.googleapis.com/auth/admin.directory.orgunit |
Alcance global para el acceso a todas las operaciones de la unidad organizativa. |
https://www.googleapis.com/auth/admin.directory.orgunit.readonly |
Permiso para recuperar solo las unidades organizativas. |
| Permisos para usuarios y alias de usuarios | Significado |
https://www.googleapis.com/auth/admin.directory.user |
Permiso global para acceder a todas las operaciones de alias de usuario y usuario. |
https://www.googleapis.com/auth/admin.directory.user.readonly |
Permiso para recuperar solo usuarios o alias de usuarios. |
https://www.googleapis.com/auth/admin.directory.user.alias |
Permiso para el acceso a todas las operaciones de alias de usuario. |
https://www.googleapis.com/auth/admin.directory.user.alias.readonly |
Permiso para recuperar solo los alias de usuario. |
| Alcances de las funciones de seguridad para los usuarios | Significado |
https://www.googleapis.com/auth/admin.directory.user.security |
Alcance para el acceso a todas las operaciones de contraseña específica de la aplicación, token de OAuth y código de verificación. |
| Permisos para la administración de funciones | Significado |
https://www.googleapis.com/auth/admin.directory.rolemanagement |
Permiso para todas las operaciones de administración de roles, incluida la creación de roles y la asignación de roles. |
https://www.googleapis.com/auth/admin.directory.rolemanagement.readonly |
Permiso para obtener y mostrar roles, privilegios y asignaciones de roles. |
| Alcances para esquemas de usuario personalizados | Significado |
https://www.googleapis.com/auth/admin.directory.userschema |
Permiso para acceder a todas las operaciones de esquema de usuario personalizado. |
https://www.googleapis.com/auth/admin.directory.userschema.readonly |
Permiso para recuperar solo esquemas de usuario personalizados. |
| Alcances para los clientes | Significado |
https://www.googleapis.com/auth/admin.directory.customer |
Alcance para el acceso a todas las operaciones del cliente. |
https://www.googleapis.com/auth/admin.directory.customer.readonly |
Es el permiso solo para recuperar clientes. |
| Alcances para los dominios | Significado |
https://www.googleapis.com/auth/admin.directory.domain |
Permiso para el acceso a todas las operaciones del dominio. |
https://www.googleapis.com/auth/admin.directory.domain.readonly |
Permiso para recuperar solo dominios. |
| Permisos para los recursos de calendario | Significado |
https://www.googleapis.com/auth/admin.directory.resource.calendar |
Permiso para acceder a todas las operaciones de recursos de calendario. |
https://www.googleapis.com/auth/admin.directory.resource.calendar.readonly |
Permiso para recuperar solo recursos de calendario. |