atlas api mongoDbCloudUsers listOrgUsers

--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 listOrgUsers

--includeCount

contagem total

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

/orgs

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

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".