Selecione um método de conexão
Ao conectar a uma conta Atlas existente a partir do Atlas CLI, você pode autenticar com uma das seguintes opções para o comando atlas auth login:
Opção | Método de autenticação | Caso de uso |
|---|---|---|
| Credenciais de login do Atlas e um token de autenticação | Ideal para uso sem necessidade de programação |
| Conta de serviço | Ideal para uso programático com uma Conta de Serviço |
| Chaves de API | Ideal para uso programático com uma chave de API |
Importante
Para versões do Atlas CLI anteriores 1.47 a, as chavesde API são armazenadas em texto simples no arquivo de configuração do Atlas CLI . As chaves de API são como senhas. Certifique-se de proteger o arquivo de configuração adequadamente. O Atlas CLI 1.47+ tenta armazenar credenciais com segurança.
Para criar uma nova conta do Atlas ou integrar uma conta existente que não tenha clusters, consulte Introdução ao Atlas.
Selecione abaixo uma ocasião de uso para saber mais sobre as opções de conexão disponíveis:
Utilize o atlas auth login comando com a UserAccount opção para autenticar com suas credenciais de login do Atlas e um token de autenticação único. A UserAccount opção exige login manual e verificação de um token de autenticação, que é válido por 12 horas. As chaves da API são opcionais ao se conectar com a UserAccount opção.
Depois de executar atlas auth login com a opção UserAccount, você pode:
Conecte-se com as configurações mínimas necessárias e especifique as flags
--projectIde--orgIdcom cada comando. Esta é a maneira mais rápida de começar para o primeiro login.Salve suas configurações de conexão em um perfil. Os perfis armazenam as IDs do projeto, as IDs da organização e, opcionalmente, as chaves de API a serem usadas nas futuras sessões do Atlas CLI. Para economizar tempo, você pode especificar um perfil em vez de usar os sinalizadores
--projectIde--orgIdcom cada comando.
Ao executar o comando atlas auth login com a opção ServiceAccounts, o Atlas CLI solicita que você forneça o ID e o segredo do cliente . A opção ServiceAccounts é boa para uso programático porque permite automatizar e gerenciar recursos do MongoDB . As Contas de Serviço, também conhecidas como aplicativos OAuth, permitem o acesso programático por meio do ID e segredo do cliente seguro especificado. Esse método funciona bem para criar scripts de casos de uso e fluxos de trabalho de integração ou entrega contínuas.
Observação
Este processo é interativo. Para autenticação programática, defina MONGODB_ATLAS_CLIENT_ID MONGODB_ATLAS_CLIENT_SECRET as variáveis de ambiente e antes de usar o {atlas-cli+}. Para saber mais sobre todas as variáveis de ambiente suportadas, consulte Variáveis de ambiente do Atlas CLI .
Você deve configurar chaves de API para autenticar com este comando.
Quando você executa o atlas auth login comando com a APIKeys opção, o Atlas CLI solicita que você forneça suas chaves API e cria automaticamente um perfil que armazena as chaves API. A APIKeys opção é boa para uso programático porque não exige login manual ou verificação de token.
Ao usar connect usando o comando atlas auth login com a opção APIKeys, você pode:
Conecte-se com as configurações mínimas necessárias e especifique as flags
--projectIde--orgIdcom cada comando. Esta é a maneira mais rápida de começar para o primeiro login.Salve as configurações de conexão adicionais em um perfil. Os perfis armazenam as IDs do projeto, as IDs da organização e, opcionalmente, as chaves de API a serem usadas nas futuras sessões do Atlas CLI. Para economizar tempo, você pode especificar um perfil em vez de usar os sinalizadores
--projectIde--orgIdcom cada comando.
Conecte-se com as Configurações Mínimas Necessárias
Selecione um caso de uso e siga as etapas para se conectar a partir do Atlas CLI com configurações mínimas necessárias.
Concluir os pré-requisitos
Adicione o endereço IP do seu host à lista de acesso IP.
Se você autenticar com suas credenciais do usuário do Atlas e os proprietários da sua organização habilitarem a Lista de acesso IP para a UI do Atlas para uma organização, seu endereço IP deverá ser adicionado à Lista de acesso IP para executar comandos nessa organização. Para saber mais, consulte Exigir Lista de Acesso IP para a UI do Atlas.
Antes de começar, verifique se tem:
Uma organização Atlas ativa.
Uma Conta de Serviço criada e configurada. Para saber mais, consulte Conceder Acesso Programático a uma Organização.
A ID do cliente e o segredo da sua conta de serviço.
Siga estas etapas
Selecione um caso de uso e siga o procedimento para se conectar rapidamente a partir do Atlas CLI.
Retorne ao Atlas CLI e aceite as opções de perfil padrão.
Retorne ao terminal. Se você se conectar com sucesso, verá uma mensagem:
Successfully logged in as {Your Email Address}.
Aceite a configuração-padrão de perfil pressionando Enter se as seguintes opções forem exibidas:
Default Org IDDefault Project IDDefault Output FormatDefault MongoDB Shell Path
Importante
Se você configurou anteriormente qualquer perfil com as chaves da API para MongoCLI, seus perfis migrarão automaticamente. Alguns perfis migrados podem fazer com que os comandos da Atlas CLI falhem durante a autenticação com atlas auth login. A seguinte mensagem é exibida quando você executa atlas auth login se houver um conflito:
There was an error fetching your organizations: Global user is from outside access listed subnets.
Para corrigir o conflito, abra o arquivo de configuração, remova o perfil padrão e execute atlas auth login novamente.
Emita comandos usando os sinalizadores --projectId --orgId e.
Ao executar os comandos do Atlas CLI durante a sessão do Atlas CLI, especifique a ID do projeto e da organização usando os sinalizadores --projectId e --orgId.
Exemplo
atlas alerts list --projectId 60b3c81153cf986293e2608b
Emita comandos usando os sinalizadores --projectId --orgId e.
Ao executar os comandos do Atlas CLI durante a sessão do Atlas CLI, especifique a ID do projeto e da organização usando os sinalizadores --projectId e --orgId.
Exemplo
atlas alerts list --projectId 60b3c81153cf986293e2608b
Emita comandos usando os sinalizadores --projectId --orgId e.
Ao executar os comandos do Atlas CLI durante a sessão do Atlas CLI, especifique a ID do projeto e da organização usando os sinalizadores --projectId e --orgId.
Exemplo
atlas alerts list --projectId 60b3c81153cf986293e2608b
Dê os próximos passos
Comece a usar os comandos CLI do Atlas.
Para salvar as configurações de conexão modificando o perfil padrão ou criando um perfil diferente, consulte Salvar configurações de conexão.