Workspace Search Users
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 (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 (default) - familyName - givenName | Propriedade a ser usada para classificar os resultados. |
show_deleted | boolean | Escolhas: - false (default) - true | Se definido como true, recupera a lista de usuários excluídos. |
view_type | string | Escolhas: - admin_view (default) - domain_public | Se deve buscar a exibição pública apenas do administrador ou de todo o domínio do usuário. |
filters | list | | Chaves e valores dados para filtrar. Veja mais em https://developers.google.com/admin-sdk/directory/v1/guides/search-users. Se string_filters for usado filters não podera ser fornecido. |
string_filters | string | | String raw fornecida pelo usuário manualente Digitado manualente: {key}{operator}{value} (exemplo: "name:seu_nome") Se string_filters for usado filters não podera ser fornecido. |
Este módulo utiliza fragmentos da documentação do módulo Workspace.
Subcampos de filters
Parâmetro | Tipo | Escolhas | Valor Padrão | Comentários |
|---|---|---|---|
key | string | | Chave para filtrar Veja mais em https://developers.google.com/admin-sdk/directory/v1/guides/search-users. |
value | string | | O valor do atributo a ser filtrado |
operator | string | Escolhas: - "=" - ":" - "<" - ">" - "<=" - ">=" | Operador que vai entre a key e o value. Veja OPERATORS em https://developers.google.com/admin-sdk/directory/v1/guides/search-users. Se inAdmin for fornecido o "=" tem que ser usado |
Exemplos
# 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: [email protected]
user_key: [email protected]
filters:
- key: name
value: "user name"
operator: ":"
- key: email
value: [email protected]
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: [email protected]
user_key: [email protected]
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: emailValores retornados
Chave | Tipo | Retornado quando | Descrição |
|---|---|---|---|
users | dictionary | Sucesso | Lista de usuários encontrados. |