Devuelve todas las claves API de su organización.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con el rol de Miembro de la organización.
Sintaxis
atlas organizations apiKeys list [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-c, --compact | false | Marca que habilita la estructura de respuesta de matriz compacta para una salida JSON. La opción --compact devuelve objetos de matriz como respuestas de nivel superior y permite la compatibilidad con scripts basados en versiones anteriores de la CLI. Si se omite la opción --compact para una salida JSON, se devuelven objetos de matriz dentro de una submatriz "results". Debe especificar --output json para usar esta opción. | |
-h, --ayuda | false | ayuda para la lista | |
--limit | Int | false | Número de elementos por página de resultados, hasta un máximo de 500. Si tiene más de 500 resultados, especifique la opción --page para cambiar la página de resultados. El valor predeterminado es 100. |
--omitCount | false | Bandera que indica si la respuesta JSON devuelve el número total de elementos (totalCount) en la respuesta JSON. | |
--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. |
-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. |
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 para la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
# Return a JSON-formatted list of organization API keys for the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys list --orgId 5a1b39eec902201990f12345 --output json