Workspace Group List
Resumo
Recupera todos os grupos de um domínio ou de um usuário com uma userKey.
Parâmetros
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
customer | string | - my_customer (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: - EMAIL | Coluna a ser usada para classificar os resultados |
maxResults | integer | | Número máximo de resultados a serem retornados. O valor máximo permitido é 200. |
pageToken | string | | Token para especificar a próxima página na lista |
filters | dict | | filtre a string de consulta. A documentação completa está em https://developers.google.com/admin-sdk/directory/v1/guides/search-groups |
string_filters | string | | filtre a dict de consulta. A documentação completa está em https://developers.google.com/admin-sdk/directory/v1/guides/search-groups |
sortOrder | string | Escolhas: - ASCENDING - DESCENDING | Se os resultados devem ser retornados em ordem crescente ou decrescente. Apenas de uso quando orderBy também é usado |
userKey | string | | E-mail ou ID imutável do usuário se apenas esses grupos forem listados, do qual o usuário é membro. Se for um ID, deve corresponder ao ID do objeto de usuário. |
Subcampos do parâmetro filters
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
key | string | | Chave a ser pesquisada |
value | string | | O conteúdo do atributo que é testado |
operator | string | Escolhas: - = - : - < - <= - > - >= | Teste que é realizado nos dados para fornecer uma correspondência Veja o link acima para usar o operador correto para cada chave/valor se inAdmin for usado, o "=" deve ser usado |
Este módulo utiliza fragmentos da documentação do módulo Workspace.
Exemplos
- name:
workspace_group_list:
service_account_email: "{{ service_account_email }}"
user_key: "{{ user_key }}"
private_key: "{{ private_key }}"
domain: "{{ domain }}"
memberKey: "{{ memberKey }}"
string_filters: "{{ string_filters }}"Valores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
kind | string | Sucesso | Tipo de recurso isso é. |
etag | string | Sucesso | ETag do recurso. |
groups | list | Sucesso | asps.list de objetos de grupo. |
nextPageToken | string | Sucesso | Token usado para acessar a próxima página deste resultado. |