Visualização pública: forneça feedback: retorna informações sobre o usuário especificado da MongoDB Cloud dentro do contexto da 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.
Observação: esse recurso só pode ser usado para buscar informações sobre usuários humanos da MongoDB Cloud. Para retornar informações sobre uma chave de API, use o endpoint de chave de API Retornar uma organização.
Observação: esse recurso não retorna informações sobre usuários pendentes convidados por meio do endpoint obsoleto Convide um usuário do MongoDB Cloud para participar de um projeto.
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-getorganizationuser.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api mongoDbCloudUsers getOrganizationUser [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 getOrganizationUser | |
--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. |
-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) |
--pretty | false | Sinalizador que indica se o corpo da resposta deve estar no formato prettyprint. | |
--userId | string | true | String hexadecimal exclusiva de 24 dígitos que identifica o usuário pendente ou ativo na organização. Se precisar consultar o userId de um usuário ou verificar o status de um usuário na organização, utilize o recurso Retornar Todos os Usuários do MongoDB Cloud em Uma Organização e filtre pelo nome de usuário. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2025-02-19"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2025-02a19". |
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 getOrganizationUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]