Atribua a chave de API da organização especificada ao seu projeto e modifique os roles da chave de API para o 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.
Ao modificar os roles de uma chave de API da organização com esse comando, os valores especificados substituem os roles existentes atribuídos à chave de API.
Para visualizar possíveis valores para o argumento ID, execute o Atlas organização apiKeys list.
Sintaxe
atlas projects apiKeys assign <ID> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ID | string | true | Sequência única de 24 dígitos que identifica sua chave API. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-h, --help | false | ajuda para atribuir | |
-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 obter a lista completa de valores aceitos, consulte o Enum de itens para o ponto de extremidade da API do Atlas correspondente: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/addProjectApiKey. Para saber mais sobre as funções de usuário no nível do projeto, consulte: 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 successfully assigned.
Exemplos
# Assign an organization API key with the ID 5f46ae53d58b421fe3edc115 and grant the GROUP_DATA_ACCESS_READ_WRITE role for the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys assign 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_DATA_ACCESS_READ_WRITE --output json