atlas api mongoDbCloudUsers listProjectUsers

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

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.

false

ajuda para listProjectUsers

false

Sinalizador que indica se a resposta retorna o número total de itens (totalCount) na resposta.

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

int

false

Número de itens que a resposta retorna por página.

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.

string

false

formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".

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)

int

false

Número da página que exibe o conjunto atual dos objetos totais que a resposta retorna.

false

Sinalizador que indica se o corpo da resposta deve estar no <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>.

string

false

Endereço de e-mail para filtrar usuários. Não é suportado em versões descontinuadas.

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