A API Directory faz parte da API RESTful Admin SDK que pode ser usada para criar e gerenciar de forma programática recursos gerenciados por uma conta do Google Workspace. Alguns casos de uso:
- Criar e gerenciar usuários e adicionar administradores
- Criar e gerenciar grupos e associações a grupos
- Monitoramento de dispositivos conectados ao domínio e ação em dispositivos perdidos.
- Gerenciar o organograma e as estruturas organizacionais.
- Auditar aplicativos aos quais seus usuários concederam acesso e revogar apps não autorizados.
Veja 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 Domínio. 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 a finalidade de aplicar políticas e conceder autorizações. Uma UO é 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 Privilégio.
- Papel
- Uma coleção definida de privilégios que podem ser atribuídos a um usuário ou a um conjunto de usuários, representados pelo recurso Role.
- Atribuição de funções
- Um registro que indica qual usuário tem quais papéis e o escopo dele. Uma atribuição de papel é representada pelo recurso RoleAssignment.
- Esquema
- Um objeto JSON que define atributos de usuário personalizados para sua organização, representados pelo recurso Esquema.
- User
- Uma conta de usuário final individual com acesso a apps e recursos do Google Workspace, representada pelo recurso User.
Próximas etapas
Para saber mais sobre o desenvolvimento com APIs do Google Workspace, incluindo o gerenciamento de autenticação e autorização, consulte Primeiros passos como desenvolvedor do Workspace.
Para saber como configurar e executar um app simples da API Directory, consulte o guia de início rápido do JavaScript.