Crea una clave de API de la organización y asígnala a tu proyecto.
MongoDB devuelve la llave privada de API solo una vez. Después de ejecutar este comando, copia, guarda y protege inmediatamente tanto las claves API públicas como las llaves privadas de API.
Para usar este comando, debes autenticarte con una cuenta de usuario o una clave API con el rol de Administrador de Usuarios de Proyecto.
Sintaxis
mongocli iam projects apiKeys create [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--desc | string | true | Descripción de la clave de API. |
-h, --help | 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, usa la opción -o json. |
--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. |
--role | Cuerdas | true | Rol o roles que deseas asignar a la clave de API. Para asignar más de un rol, especifica cada rol con una bandera de rol separada o especifica todos los roles como una lista separada por comas utilizando una bandera de rol. Para conocer qué valores acepta la CLI, consulte Items Enum para roles en la especificación de 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 a usar de tu archivo de configuración. Para aprender 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 '<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 iam projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role ORG_OWNER --output json