Descripción general de la API de Directory
Organiza tus páginas con colecciones
Guarda y categoriza el contenido según tus preferencias.
La API de Directory forma parte de la API del SDK de Admin basada en REST que se puede usar para crear y administrar de forma programática los recursos controlados por el administrador que son propiedad de una cuenta de Google Workspace. En algunos casos de uso se incluye lo siguiente:
- Crear y administrar usuarios, y agregar administradores
- Crear y administrar grupos y membresías de grupos
- Supervisar los dispositivos conectados a tu dominio y tomar medidas en relación con los dispositivos perdidos
- Administrar tu organigrama y las estructuras organizativas
- Auditar las aplicaciones a las que tus usuarios otorgaron acceso y revocar las aplicaciones no autorizadas
A continuación, se incluye una lista de términos comunes que se usan en la API de Directory:
- Cliente
- Es la entidad propietaria de la cuenta de Google Workspace, representada por el recurso Customer.
- Dominio
- Si corresponde, el dominio de DNS asociado con una cuenta de Google Workspace, representado por el recurso Domain. No todas las cuentas tienen un dominio asociado.
- Unidad organizativa (UO)
- Es una subunidad del árbol organizacional de una cuenta de Google Workspace que se usa para agrupar y ordenar a los usuarios con el fin de aplicar políticas y otorgar autorizaciones. Una OU se representa con el recurso OrgUnit.
- Privilegio
- Es la capacidad de un usuario para realizar una acción en un recurso de Google Workspace.
Se aplica principalmente a los administradores. Un privilegio se representa con el recurso Privilege.
- Función
- Es una colección definida de privilegios que se pueden asignar a un usuario o a un conjunto de usuarios, y que se representa con el recurso Role.
- Asignación de roles
- Un registro que indica a qué usuario se le otorgan qué roles y en qué alcance.
Una asignación de rol se representa con el recurso RoleAssignment.
- Esquema
- Objeto JSON que define atributos del usuario personalizados para tu organización, representados por el recurso Schema.
- Usuario
- Cuenta de usuario final individual con acceso a las apps y los recursos de Google Workspace, representada por el recurso User.
Próximos pasos
Salvo que se indique lo contrario, el contenido de esta página está sujeto a la licencia Atribución 4.0 de Creative Commons, y los ejemplos de código están sujetos a la licencia Apache 2.0. Para obtener más información, consulta las políticas del sitio de Google Developers. Java es una marca registrada de Oracle o sus afiliados.
Última actualización: 2025-08-29 (UTC)
[null,null,["Última actualización: 2025-08-29 (UTC)"],[],[],null,["# Directory API Overview\n\n|-------------------------------------------------------------------------------------------------------------------------------------------|\n| Got 5 minutes? Help us improve our Google Workspace documentation by taking a quick [online survey](https://forms.gle/XcqRP3PJiQv9ADuj9). |\n\nThe Directory API is part of the RESTful Admin SDK API that can be used to\nprogrammatically create and manage admin-controlled resources owned by a\nGoogle Workspace account. Some use cases include:\n\n- Creating and managing users and adding administrators.\n- Creating and managing groups and group memberships.\n- Monitoring devices connected to your domain and taking action on lost devices.\n- Managing your org chart and organization structures.\n- Auditing applications your users have granted access to and revoking unauthorized apps.\n\nFollowing is a list of common terms used in the Directory API:\n\n*Customer*\n: The entity that owns the Google Workspace account, represented by the\n [Customer](/workspace/admin/directory/reference/rest/v1/customers) resource.\n\n*Domain*\n: If applicable, the DNS domain associated with a Google Workspace account,\n represented by the\n [Domain](/workspace/admin/directory/reference/rest/v1/domains) resource. Not all\n accounts have an associated domain.\n\n*Organizational unit (OU)*\n: A sub-unit of a Google Workspace account's organizational tree, used to\n group and sort users for the purpose of applying policies and granting\n authorizations. An OU is represented by the\n [OrgUnit](/workspace/admin/directory/reference/rest/v1/orgunits) resource.\n\n*Privilege*\n: The ability of a user to perform an action on a Google Workspace resource.\n Applies primarily to admins. A privilege is represented by the\n [Privilege](/workspace/admin/directory/reference/rest/v1/privileges/list#Privilege)\n resource.\n\n*Role*\n: A defined collection of privileges that can be assigned to a user or set of\n users, represented by the\n [Role](/workspace/admin/directory/reference/rest/v1/roles) resource.\n\n*Role assignment*\n: A record indicating which user is granted what roles, and over what scope.\n A role assignment is represented by the\n [RoleAssignment](/workspace/admin/directory/reference/rest/v1/roleAssignments)\n resource.\n\n*Schema*\n: A JSON object that defines custom user attributes for your organization,\n represented by the\n [Schema](/workspace/admin/directory/reference/rest/v1/schemas) resource.\n\n*User*\n: An individual end user account with access to Google Workspace apps and\n resources, represented by the\n [User](/workspace/admin/directory/reference/rest/v1/users) resource.\n\nNext steps\n----------\n\n- To learn about developing with Google Workspace APIs, including handling\n authentication and authorization, refer to\n [Get started as a Workspace developer](/workspace/guides/getstarted-overview).\n\n- To learn how to configure and run a simple Directory API app, try the\n [JavaScript quickstart](/workspace/admin/directory/v1/quickstart/js)."]]
