- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Cree una clave API para su organización.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
MongoDB devuelve la clave API privada solo una vez. Después de ejecutar este comando, copie, guarde y proteja inmediatamente las claves API pública y privada.
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
atlas organizations apiKeys create [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--desc | string | true | Descripción de la clave API. |
-h, --ayuda | false | ayuda para crear | |
--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. |
--role | cadenas | true | Rol o roles que desea asignar a la clave de API. Para asignar más de un rol, especifique cada rol con una marca de rol independiente o especifique todos los roles como una lista separada por comas usando una sola marca de rol. Para ver la lista completa de valores aceptados, consulte la enumeración de elementos del punto de conexión de la API de Atlas correspondiente: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createApiKey. Para obtener más información sobre los roles de usuario a nivel de organización, consulte: https://dochub.mongodb.org/core/atlas-org-roles. |
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 la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
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 '<Id>' created. Public API Key <PublicKey> Private API Key <PrivateKey>
Ejemplos
# Create an organization API key with organization owner access in the organization with the ID 5a1b39eec902201990f12345: atlas organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json