Atlas organização apiKeys delete
Remova a chave de API especificada da sua organização.
Para visualizar possíveis valores para o argumento ID, execute o Atlas organização 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 da organização.
Sintaxe
Sintaxe do comando
atlas organizations apiKeys delete <ID> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
ID | string | true | String exclusiva de 24 dígitos que identifica a chave de API da organização. |
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 | |
--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. |
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 '<Name>' deleted
Exemplos
# Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345