Crea una clave de API de la organización y asígnala a tu 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. Si no proporciona un rol de nivel de organización, la clave API se establece de forma predeterminada como miembro de la organización principal del proyecto.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con cualquiera de los siguientes roles: Administrador de usuarios del proyecto o Administrador de usuarios de la organización para administrar roles de nivel de organización.
Sintaxis
atlas 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, use 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 usando una sola bandera de rol. Para la lista completa de valores aceptados, consulta el Enum de Items para el endpoint correspondiente de la API de Atlas: https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operación/operación-createprojectapikey. Para aprender más sobre los roles de usuario a nivel de proyecto, consulta: https://dochub.mongodb.org/core/atlas-proj-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, 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 GROUP_OWNER role and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_OWNER --output json
# Create an organization API key with the GROUP_SEARCH_INDEX_EDITOR and GROUP_DATABASE_ACCESS_ADMIN roles and assign it to the project with ID 5e2211c17a3e5a48f5497de3: atlas projects apiKeys create --desc "My API key" --projectId 5e1234c17a3e5a48f5497de3 --role GROUP_SEARCH_INDEX_EDITOR,GROUP_DATABASE_ACCESS_ADMIN --output json