Retornar os detalhes do Atlas user especificado .
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 feedback em https://feedback.mongodb.com/fóruns/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.
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
atlas users describe [options]
Opções
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. |
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. |
Saída
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>
Exemplos
# 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