Retorna os detalhes de uma conta de usuário do MongoDB Cloud com o identificador exclusivo especificado para o usuário.
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades 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 ponto de extremidade da API fornecido.
Não é possível usar esse ponto de extremidade para retornar informações sobre uma chave de API. Para retornar informações sobre uma chave de API, use o ponto de extremidade da chave de API Retornar uma organização. Você sempre pode recuperar sua própria conta de usuário. Se você for o proprietário de uma organização ou projeto do MongoDB Cloud, também poderá recuperar o perfil de usuário de qualquer usuário com uma adesão a essa organização ou projeto. Para usar este recurso, a conta de serviço ou a chave de API solicitante pode ter qualquer função.
Este comando é gerado automaticamente e corresponde 1:1 ao ponto de extremidade da API do Atlashttps://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operação/operação-getuser.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api mongoDbCloudUsers getUser [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 getUser | |
-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 única de 24 dígitos hexadecimais que identifica este usuário. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2023-01a01". |
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. |