mongocli iam projetos apiKeys delete
Remova a chave de API da organização especificada do seu projeto.
A chave de API ainda existe no nível da organização . Para reatribuir a chave de API da organização a um projeto, execute o comando mongocli iam projects apiKeys assign.
Para visualizar os valores possíveis para o argumento ID, execute mongocli iam organizations apiKeys list.
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
mongocli iam projects apiKeys delete <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 |
|---|---|---|---|
--force | false | Sinalizador que indica se o prompt de confirmação deve ser ignorado antes de prosseguir com a ação solicitada. | |
-h, --help | false | ajuda para excluir | |
--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. |
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 MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
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 '<Name>' deleted
Exemplos
# Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: mongocli iam projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3