Elimine la clave API especificada para su organización.
Para ver los valores posibles para el argumento ID, ejecute mongocli organisations apiKeys list.
Para utilizar este comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de administrador de usuarios de la organización.
Sintaxis
mongocli iam organizations apiKeys delete <ID> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID | string | true | Cadena única de 24dígitos que identifica la clave API de la organización. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--force | false | Bandera que indica si se debe omitir la solicitud de confirmación antes de continuar con la acción solicitada. | |
-h, --ayuda | false | ayuda para eliminar | |
--orgId | string | false | ID de organización a utilizar. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
API Key '<Name>' deleted
Ejemplos
# Remove the organization API key with the ID 5f24084d8dbffa3ad3f21234 for the organization with the ID 5a1b39eec902201990f12345: mongocli organizations apiKeys delete 5f24084d8dbffa3ad3f21234 --orgId 5a1b39eec902201990f12345