Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas CLI
/
Comandos
/
organizações
/
Chaves de API

Atlas organização apiKeys criar

Nesta página

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

Crie uma chave API para a sua organização.

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 da organização.

Sintaxe

Sintaxe do comando
atlas organizations 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

--orgId

string

false

ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

-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.

--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/createApiKey/.

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.

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

Exemplos

# Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345:
atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json

Voltar

atribuir

Próximo

excluir