Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ /

os usuários do atlas descrevem

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Retornar os detalhes do Atlas user especificado .

Você pode especificar o ID exclusivo de 24dígitos que identifica o Atlas user ou o nome de usuário do usuário do Atlas user.

Contas de usuário e chaves de API com qualquer função podem executar este comando.

Sintaxe do comando
atlas users describe [options]
Nome
Tipo
Obrigatório
Descrição

-h, --help

false

ajuda para descrever

--id

string

false

Identificador único de 24 dígitos do usuário.

Mutuamente exclusivo com --username.

-o, --output

string

false

Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.

--username

string

false

Nome que identifica o usuário. Você deve especificar um endereço de e-mail válido.

Mutuamente exclusivo com --id.

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.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

ID FIRST NAME LAST NAME USERNAME EMAIL
<Id> <FirstName> <LastName> <Username> <EmailAddress>
# Return the JSON-formatted details for the Atlas user with the ID 5dd56c847a3e5a1f363d424d:
atlas users describe --id 5dd56c847a3e5a1f363d424d --output json
# Return the JSON-formatted details for the Atlas user with the username myUser:
atlas users describe --username myUser --output json

Voltar

Usuários