---
title: Workspace User Info
slug: homologacao-atmosphere/workspace-user-info
description: Learn about the "workspace_user_info" module, an extension of the Workspace module, in this summary document. Discover how this module enables users to conveniently list Google Workspace users using parameters like customer, domain, order_by, show_deleted
docTags: 
createdAt: 2021-07-12T11:33:35.000Z
---

## Resumo

- Lista os usuários do Google Workspace.

## Parâmetros

| **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão**                                             | **Comentários**                                                                            |
| ------------- | -------- | ------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ |
| customer      | string   | - my\_customer<br />(default)                                            | ID exclusivo da conta do Google Workspace                                                  |
| domain        | string   |                                                                          | Nome do domínio. Use este campo para obter campos de apenas um domínio.                    |
| order\_by     | string   | Escolhas:<br />- email<br />(default)<br />- familyName<br />- givenName | Propriedade a ser usada para classificar os resultados.                                    |
| show\_deleted | boolean  | Escolhas:<br />- false<br />(default)<br />- true                        | Se definido como true, recupera a lista de usuários excluídos.                             |
| view\_type    | string   | Escolhas:<br />- admin\_view<br />(default)<br />- domain\_public        | Se deve buscar a exibição pública apenas do administrador ou de todo o domínio do usuário. |

Este módulo extende fragmentos do módulo Workspace.

## Exemplos

```yaml
# Exemplo: Procurando um usuário
- workspace_user_info:
    service_account_email: service_acc_email@your.domain.com
    user_key: user_key@your.domain.com
    private_key: |-
        -----BEGIN PRIVATE KEY-----
        -----END PRIVATE KEY-----
    view_type: domain_public
    customer: my_customer
    domain: your.domain.com
    order_by: email
```



## Valores retornados

| **Chave** | **Tipo**   | **Retornado quando** | **Descrição**                  |
| --------- | ---------- | -------------------- | ------------------------------ |
| users     | dictionary | Sucesso              | Lista de usuários encontrados. |