Devuelve todas las claves API de la organización asignadas a tu proyecto.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con el rol de administrador de usuario del proyecto.
Sintaxis
atlas projects apiKeys list [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-c, --compact | false | Indicador que habilita la estructura compacta de arreglos en la salida JSON. La opción --compact devuelve objetos de arreglo como respuestas de nivel superior y permite la compatibilidad con versiones anteriores para scripts basados en versiones anteriores de CLI. Omitir la opción --compact para una salida JSON devuelve objetos de arreglo dentro de un sub-arreglo 'results'. Debe especificar --output json para utilizar esta opción. | |
-h, --help | false | ayuda para la lista | |
--limit | Int | false | Número de elementos por página de resultados, hasta un máximo de 500. Si tienes más de 500 resultados, especifica la opción --page para cambiar la página de resultados. Este valor es 100 por defecto. |
--omitCount | false | Indicador que señala si la respuesta JSON devuelve el número total de elementos (totalCount) en la respuesta JSON. | |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--page | Int | false | Número de página que especifica una página de resultados. Este valor es por defecto 1. |
--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 sobre los perfiles para Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
# Return a JSON-formatted list of organization API keys assigned to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys list --projectId 5e1234c17a3e5a48f5497de3 --output json