---
title: Workspace Organizational Unit List
slug: homologacao-atmosphere/workspace-organizational-unit-list
description: Learn how to use the Google Workspace module to retrieve detailed information on organizational units. This document includes step-by-step instructions, required parameters, and an example of listing all units. Discover the valuable data returned by the m
docTags: 
createdAt: 2022-05-16T13:18:30.000Z
---

## Resumo

- Este módulo retorna informações sobre várias unidades organizacionais no Google Workspace.

## Parâmetros

| **Parâmetro**                    | **Tipo** | **Escolhas \| Valor Padrão**  | **Comentários**                                                                                                                                                                                                                                                           |
| -------------------------------- | -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| customer                         | string   | - my\_customer<br />(default) | O ID exclusivo da conta do Google Workspace do cliente. No caso de uma conta de vários domínios, para buscar todos os grupos de um cliente, preencha este campo em vez de domínio. Você também pode usar o alias my\_customer para representar o customerId da sua conta. |
| orgUnitPath - *required  &#x20;* | raw      |                               | Caminho completo da unidade organizacional (menos o / inicial) ou seu ID exclusivo.                                                                                                                                                                                       |
| type -<br />*required*           | string   |                               | Tipo da unidade organizacional.                                                                                                                                                                                                                                           |

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

## Exemplos

```yaml
# Exemplo: Listar todas as unidades organizacionais
- workspace_organizational_unit_list:
    service_account_email: service_acc_email@your.domain.com
    user_key: user_key@your.domain.com
    private_key: |-
        -----BEGIN PRIVATE KEY-----
        -----END PRIVATE KEY-----
    customer: my_customer
    orgUnitPath: 'my_org'
    type: ALL
```



## Valores retornados

| **Chave**         | **Tipo** | **Retornado quando** | **Descrição**                                   |
| ----------------- | -------- | -------------------- | ----------------------------------------------- |
| kind              | string   | Sucesso              | Tipo do recurso de API.                         |
| etag              | string   | Sucesso              | ETag do recurso.                                |
| name              | string   | Sucesso              | Nome do caminho da unidade organizacional.      |
| description       | string   | Sucesso              | Descrição da unidade organizacional.            |
| orgUnitPath       | string   | Sucesso              | Caminho completo para a unidade organizacional. |
| orgUnitId         | string   | Sucesso              | ID exclusivo da unidade organizacional.         |
| parentOrgUnitPath | string   | Sucesso              | Caminho pai da unidade organizacional.          |
| parentOrgUnitId   | string   | Sucesso              | ID exclusivo da unidade organizacional pai.     |