Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas CLI
/
Comandos
/
projects
/
Chaves de API

atlas projetos apiKeys criar

Nesta página

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

Crie uma chave de API da organização e atribua-a ao seu projeto.

O MongoDB retorna a chave de API privada apenas uma vez. Depois de executar este comando, copie, salve e proteja imediatamente a chave de API privada e pública.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de administrador do usuário do projeto.

Sintaxe

Sintaxe do comando
atlas projects apiKeys create [options]

Opções

Nome
Tipo
Obrigatório
Descrição
--desc
string
true
Descrição da chave API.
-h, --help
false
ajuda para criar
-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.
--projectId
string
false
String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.
--role
strings
true
Função ou funções que você deseja atribuir à chave de API. Para atribuir mais de uma função, especifique cada função com um sinalizador de função separado ou especifique todas as funções como uma lista separada por vírgula usando um sinalizador de função. Para saber quais valores o CLI aceita, consulte o Enum de itens para roles nas especificações da API do Atlas: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/ #tag/Programmatic-API-Keys/operation/createProjectApiKey/.

Opções herdadas

Nome
Tipo
Obrigatório
Descrição
-P, --profile
string
false

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.

API Key '<Id>' created.
Public API Key <PublicKey>
Private API Key <PrivateKey>

Exemplos

# Create an organization API key with the GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3:
atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json

Voltar

atribuir

Próximo

excluir