---
title: Workspace Search Users
slug: homologacao-atmosphere/workspace-search-users
description: Learn how to use the "workspace_user_search" module in the Google Workspace API to search for users or user groups within your Google Workspace account. This document outlines the parameters available for the search, such as customer ID, domain name, orde
docTags: 
createdAt: 2022-05-05T18:42:06.000Z
---

## Resumo

- Lista os gruopo de usuários ou usuários especificos 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.                                                                                                                                                                                             |
| filters<br />         | list     |                                                                          | Chaves e valores dados para filtrar.<br />Veja mais em [https://developers.google.com/admin-sdk/directory/v1/guides/search-users](https://developers.google.com/admin-sdk/directory/v1/guides/search-users).<br />Se string\_filters for usado filters não podera ser fornecido.<br /> |
| string\_filters<br /> | string   |                                                                          | String raw fornecida pelo usuário manualente<br />Digitado manualente: \{key}\{operator}\{value} (exemplo: "name\:seu\_nome")<br />Se string\_filters for usado filters não podera ser fornecido.<br />                                                                                |

Este módulo utiliza fragmentos da documentação do módulo [Workspace](docId\:MvNMRc1xn5bb_Uxn3cKpA).

## Subcampos de filters

| **Parâmetro** | **Tipo** | **Escolhas \| Valor Padrão**                                                    | **Comentários**                                                                                                                                                                                                                                                              |
| ------------- | -------- | ------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| key           | string   |                                                                                 | Chave para filtrar<br />Veja mais em [https://developers.google.com/admin-sdk/directory/v1/guides/search-users](https://developers.google.com/admin-sdk/directory/v1/guides/search-users).                                                                                   |
| value         | string   |                                                                                 | O valor do atributo a ser filtrado                                                                                                                                                                                                                                           |
| operator      | string   | Escolhas:<br />- "="<br />- ":"<br />- "\<"<br />- ">"<br />- "\<="<br />- ">=" | Operador que vai entre a key e o value.<br />Veja OPERATORS em [https://developers.google.com/admin-sdk/directory/v1/guides/search-users](https://developers.google.com/admin-sdk/directory/v1/guides/search-users).<br />Se `inAdmin` for fornecido o "=" tem que ser usado |

## Exemplos

```yaml
# Exemplo: Procurando um grupo de usuários ou um usuário especifico
# Exemplo: Filtros preenchidos automaticamente
- name: Searching for a user
  workspace_user_search:
    service_account_email: service_acc_email@your.domain.com
    user_key: user_key@your.domain.com
    filters:
      - key: name
        value: "user name"
        operator: ":"
      - key: email
        value: user-email@.com
        operator: ":"
      - key: isAdmin
        value: True
        operator: "="
    private_key: |-
        -----BEGIN PRIVATE KEY-----
        -----END PRIVATE KEY-----
    view_type: domain_public
    customer: my_customer
    domain: your.domain.com
    order_by: email
    
# Exemplo: Filtros preenchidos manualmente   
- name: Searching for a user set filters manually
  workspace_user_search:
    service_account_email: service_acc_email@your.domain.com
    user_key: user_key@your.domain.com
    string_filters: 'givenName:user given name'
    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. |