Skip to main content

Autenticar na CLI

Objetivo​

Autentique-se na CLI para executar comandos nos recursos da sua conta da Magalu Cloud. Neste guia, você vai aprender a fazer login pelo navegador, em máquinas sem navegador e com API key, além de obter o token de acesso e fazer logout.

Pré-requisitos​

Como fazer​

Fazer login pelo navegador​

Execute o comando abaixo:

mgc auth login

O seu navegador padrão abre a página de login do ID Magalu. Depois de fazer o login, volte ao terminal: a CLI exibe a confirmação e salva as credenciais no workspace ativo.

info

As credenciais valem apenas para o workspace ativo. Se você usa mais de um workspace, faça o login em cada um deles. Elas ficam salvas no arquivo auth.yaml, dentro da pasta do workspace, no diretório de configuração do seu sistema operacional:

  • Linux: ~/.config/mgc/<nome-do-workspace>/ (ou $XDG_CONFIG_HOME/mgc/<nome-do-workspace>/, se a variável estiver definida)
  • macOS: ~/Library/Application Support/mgc/<nome-do-workspace>/
  • Windows: %AppData%\mgc\<nome-do-workspace>\

Veja mais em Administrar workspaces.

Fazer login em uma máquina sem navegador​

Use o login headless quando a CLI estiver em uma máquina sem navegador, como uma máquina virtual acessada por SSH.

  1. Na máquina sem navegador, execute:

    mgc auth login --headless=true

  2. Copie a URL exibida no terminal e abra-a no navegador de outro computador.

  3. Faça o login no ID Magalu.

  4. Ao final, o navegador é redirecionado para um endereço que começa com localhost. Copie o endereço completo da barra do navegador, mesmo que a página não carregue.

  5. Cole o endereço no terminal da máquina sem navegador e pressione Enter.

Para abrir a URL de login pelo celular em vez de copiá-la, use a flag --qrcode no lugar de --headless e leia o QR code exibido no terminal.

Autenticar com API key​

A autenticação com API key é indicada para automações e scripts, em que não é possível fazer login pelo navegador. Antes de começar, crie uma API key.

Você pode informar a API key de duas formas:

  • Em uma variável de ambiente: defina a variável MGC_API_KEY para que todos os comandos executados no terminal usem a API key. Veja como em Usar variáveis de ambiente.

  • Diretamente no comando: adicione a flag --api-key a um comando específico:

    mgc virtual-machine instances list --api-key="sua-api-key"
warning

Enquanto a variável MGC_API_KEY estiver definida, a CLI usa a API key no lugar das credenciais do login. Para voltar a usar o login, remova a variável.

Obter o token de acesso​

Para usar o token de acesso em requisições diretas à API da Magalu Cloud, execute:

mgc auth access-token

Também é possível exibir o token logo após o login, adicionando a flag --show ao comando mgc auth login.

Fazer logout​

Para remover as credenciais salvas no workspace ativo, execute:

mgc auth logout

Perguntas frequentes​

Quando devo usar o login e quando devo usar a API key?
Use o login para trabalhar no terminal no dia a dia. Use a API key em scripts, pipelines de CI/CD e outras automações, em que não há uma pessoa para fazer login pelo navegador.

Preciso fazer login de novo ao trocar de workspace?
Sim, se o workspace ainda não tiver credenciais. Cada workspace guarda as próprias credenciais de acesso. Veja mais em Administrar workspaces.

Próximos passos​