Elimina la clave API de la organización especificada de tu proyecto.
La clave API aún existe a nivel de organización. Para reasignar la clave de API de la organización a un proyecto, ejecute el comando mongocli projects apiKeys assign.
Para ver los posibles valores del argumento ID, ejecutar mongocli organizations apiKeys list.
Para utilizar este comando, debe autenticarse con una cuenta de usuario o una clave API con el rol de administrador de usuario del proyecto.
Sintaxis
mongocli iam projects apiKeys delete <ID> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
ID | string | true | string única de 24 dígitos que identifica tu clave API. |
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, --help | false | ayuda para eliminar | |
--projectId | string | false | string hexadecimal que identifica el Proyecto a utilizar. Esta opción anula la configuración en el 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á del archivo de configuración. Para aprender más sobre los perfiles para MongoCLI, consulta https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Salida
Si el comando se ejecuta correctamente, el CLI devuelve una salida similar a la siguiente muestra. Los valores entre corchetes representan tus valores.
API Key '<Name>' deleted
Ejemplos
# Remove an organization API key with the ID 5f46ae53d58b421fe3edc115 from the project with ID 5e2211c17a3e5a48f5497de3: mongocli projects apiKeys delete 5f46ae53d58b421fe3edc115 --projectId 5e1234c17a3e5a48f5497de3