Visão geral da API Directory
Mantenha tudo organizado com as coleções
Salve e categorize o conteúdo com base nas suas preferências.
A API Directory faz parte da API Admin SDK RESTful, que pode ser usada para
criar e gerenciar de forma programática recursos controlados por administradores de uma
conta do Google Workspace. Estes são alguns exemplos de casos de uso:
- Criar e gerenciar usuários e adicionar administradores.
- Criar e gerenciar grupos e associações a grupos.
- Monitorar dispositivos conectados ao seu domínio e tomar medidas em dispositivos perdidos.
- Gerenciar organogramas e estruturas organizacionais.
- Auditar os aplicativos a que os usuários concederam acesso e revogar
apps não autorizados.
Confira a seguir uma lista de termos comuns usados na API Directory:
- Cliente
- A entidade proprietária da conta do Google Workspace, representada pelo recurso Customer.
- Domínio
- Se aplicável, o domínio DNS associado a uma conta do Google Workspace,
representado pelo recurso
Domain. Nem todas as contas têm um domínio associado.
- Unidade organizacional (UO)
- Uma subunidade da árvore organizacional de uma conta do Google Workspace, usada para agrupar e classificar usuários com o objetivo de aplicar políticas e conceder autorizações. Uma OU é representada pelo recurso OrgUnit.
- Privilégio
- A capacidade de um usuário realizar uma ação em um recurso do Google Workspace.
Aplicável principalmente a administradores. Um privilégio é representado pelo recurso Privilege.
- Cargo
- Uma coleção definida de privilégios que podem ser atribuídos a um usuário ou conjunto de usuários, representada pelo recurso Role.
- Atribuição de função
- Um registro que indica quais papéis foram concedidos a qual usuário e em qual escopo.
Uma atribuição de função é representada pelo recurso RoleAssignment.
- Esquema
- Um objeto JSON que define atributos de usuário personalizados para sua organização, representados pelo recurso Schema.
- Usuário
- Uma conta de usuário final individual com acesso a apps e recursos do Google Workspace, representada pelo recurso User.
Próximas etapas
Exceto em caso de indicação contrária, o conteúdo desta página é licenciado de acordo com a Licença de atribuição 4.0 do Creative Commons, e as amostras de código são licenciadas de acordo com a Licença Apache 2.0. Para mais detalhes, consulte as políticas do site do Google Developers. Java é uma marca registrada da Oracle e/ou afiliadas.
Última atualização 2025-08-29 UTC.
[null,null,["Última atualização 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)."]]
