Visualização pública: forneça comentários: retorna detalhes sobre os usuários pendentes e ativos da MongoDB Cloud associados à organização especificada.
Visualização pública: o subcomando da API atlas, gerado automaticamente a partir da API de administração do MongoDB Atlas, oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça comentários em https://feedback.mongodb.com/forums/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.
Para usar este recurso, a conta de serviço ou chave de API solicitante deve ter a função de membro da organização.
Nota: este recurso não pode ser utilizado para visualizar detalhes sobre usuários convidados através do ponto de extremidade obsoleto Convide um usuário do MongoDB Cloud para participar de um projeto.
Nota: para retornar tanto usuários pendentes quanto ativos, use a v2-{2025-02-19} ou posterior. Se estiver usando uma versão descontinuada, apenas usuários ativos serão retornados.
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation/listorganizationusers.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api mongoDbCloudUsers listOrganizationUsers [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
-h, --help | false | ajuda para listOrganizationUsers | |
--includeCount | false | Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta. | |
--itemsPerPage | int | false | Número de itens que a resposta retorna por página. |
--orgId | string | true | String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações às quais o usuário autenticado tem acesso. |
--orgMembershipStatus | string | false | Status de associação à organização para filtrar usuários. Se você excluir este parâmetro, o recurso retornará usuários pendentes e ativos. Não é suportado em versões descontinuadas. |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | string | false | no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip) |
--pageNum | int | false | Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna. |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--username | string | false | Endereço de e-mail para filtrar usuários. Não é suportado em versões descontinuadas. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01", "2025-02-19"], os padrões para a versão mais recente ou os perfis api_version valor de configuração se definido Este valor padrão é "2025-02-19". |
Opções herdadas
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-P, --profile | string | false | Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Exemplos
atlas api mongoDbCloudUsers listOrganizationUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE