atlas api mongoDbCloudUsers listProjectUsers

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

Visualização pública: forneça comentários: retorna detalhes sobre os usuários pendentes e ativos da MongoDB Cloud associados ao projeto especificado.

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 esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.

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 ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-listprojectusers.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api mongoDbCloudUsers listProjectUsers [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.
-- flattenTeams	" flattenTeams " : false	false	Sinalizador que indica se a lista retornada deve incluir usuários que pertencem a uma equipe com uma role neste projeto. Talvez você não tenha atribuído uma role aos usuários individuais neste projeto. Se " flattenTeams " : false, esse recurso retornará apenas usuários com uma role no projeto. Se `"flattenTeams" : true`, este recurso retornará tanto os usuários com roles no projeto quanto os usuários que pertencem a equipes com roles no projeto.
--groupId	string	true	Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos.
-h, --help		false	ajuda para listProjectUsers
--includeCount		false	Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.
--includeOrgUsers	"includeOrgUsers": false	false	Sinalizador que indica se a lista retornada deve incluir usuários com acesso implícito ao projeto, às roles "Proprietário da organização" ou "Somente leitura da organização". Talvez você não tenha atribuído uma role aos usuários individuais neste projeto. Se "includeOrgUsers": false, este recurso retornará apenas usuários com uma role no projeto. Se `"includeOrgUsers": true`, este recurso retornará usuários com roles no projeto e usuários com acesso implícito ao projeto por meio de sua role da organização .
--itemsPerPage	int	false	Número de itens que a resposta retorna por página.
--orgMembershipStatus	string	false	Sinalizador que indica se a lista retornada deve ser filtrada pelo status de associação à organização do usuário. 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 listProjectUsers --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --orgMembershipStatus ACTIVE

Voltar

listOrganizationUsers

listTeamUsers