atlas api mongoDbCloudUsers getUser

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

experimental: retorna os detalhes de uma conta de usuário do MongoDB Cloud com o identificador exclusivo especificado para o usuário.

Você não pode usar esse ponto de conexão para retornar informações sobre uma chave API. Para retornar informações sobre uma chave de API, use o endpoint de 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 esse recurso, a chave de API solicitante pode ter qualquer role. Este comando está invocando o endpoint com OperationID: 'getUser'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Usuários/operação/getUser

Sintaxe

Sintaxe do comando

atlas api mongoDbCloudUsers getUser [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--envelope		false	sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope
-h, --help		false	ajuda para getUser
--output	string	false	formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".
--output-file	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 de impressão bonita
--userId	string	true	string exclusiva de dígitos hexadecimais 24que 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.