Crie uma chave de API da organização e atribua-a ao seu projeto.
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.
O MongoDB retorna a chave de API privada apenas uma vez. Depois de executar este comando, copie, salve e proteja imediatamente as chaves de API pública e privada. Se você não fornecer uma função de nível de organização , a chave de API assumirá como padrão o membro da organização da organização principal do projeto .
Para usar esse comando, você deve autenticar com uma conta de usuário ou uma chave de API com qualquer uma das seguintes funções: Administrador do usuário do projeto ou Administrador do usuário da organização para gerenciar funções de nível da organização .
Sintaxe
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 | Role or roles that you want to assign to the API key. To assign more than one role, specify each role with a separate role flag or specify all of the roles as a comma-separated list using one role flag. For the full list of accepted values, see the Items Enum for the corresponding Atlas API endpoint: https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. To learn more about project level user roles, see: https://dochub.mongodb.org/core/atlas-proj-roles. |
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 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
# Create an organization API key with the GROUP_SEARCH_INDEX_EDITOR and GROUP_DATABASE_ACCESS_ADMIN roles and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_SEARCH_INDEX_EDITOR,GROUP_DATABASE_ACCESS_ADMIN --output json