Cree una clave API de organización y asígnela a su proyecto.
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 usuario del proyecto.
Sintaxis
mongocli iam projects apiKeys create [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--desc | string | true | Descripción de la clave API. |
-h, --ayuda | false | ayuda para crear | |
-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. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
--role | cadenas | true | Rol o roles que desea asignar a la clave 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 saber qué valores acepta la CLI, consulte la enumeración de elementos para roles en la especificación de la API de Atlas: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#tag/Programmatic-API-Keys/operation/createProjectApiKey/. |
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 '<ID>' created. Public API Key <PublicKey> Private API Key <PrivateKey>
Ejemplos
# Create an organization API key with the ORG_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: mongocli projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role ORG_OWNER --output json