atlas api mongoDbCloudUsers listGroupUsers

--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 função neste projeto. Talvez você não tenha atribuído uma função aos usuários individuais neste projeto. Se "flattenTeams" : false, esse recurso retornará apenas usuários com uma função no projeto. Se "flattenTeams" : true, este recurso retornará tanto os usuários com funções no projeto quanto os usuários que pertencem a equipes com funções 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 listGroupUsers

--includeCount

contagem total

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

orgMembershipStatuses

false

Obsoleto: use orgMembershipStatuses em vez disso. Status de associação à organização para filtrar usuários. Valores permitidos: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Se você excluir este parâmetro, este recurso retornará usuários ATIVOS e PENDENTES. Não é suportado em versões descontinuadas.

--orgMembershipStatuses

Ativo

false

Status de associação à organização para filtrar usuários. Você pode fornecer este parâmetro várias vezes. Valores permitidos: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Substitui o parâmetro obsoleto orgMembershipStatus. Se você excluir este parâmetro, este recurso retornará usuários ACTIVE e PENDENTE. Não pode ser combinado com orgMembershipStatus. 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 os pontos de extremidade da Atlas API [opções: "2023-01-01", "2025-02-19"]. Se não for definido pelo usuário, o padrão será a versão mais recente ou o valor de configuração api_version do perfil, se definido. Este valor tem como padrão "2025-02-19".