atlas projects apiKeys create

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 de API públicas como las llaves privadas de API. Si no proporciona un rol a nivel de organización, la API Key se establecerá, por defecto, como miembro de la organización en la organización principal del proyecto.

Para utilizar este comando, debes 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 los roles a nivel de organización.

Sintaxis

Sintaxis del comando

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, 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 API. Para asignar más de un rol, especifica cada rol con un indicador de rol independiente o indica todos los roles como una lista separada por comas usando un solo indicador de rol. Para obtener la lista completa de valores aceptados, consulta la Enum de ítems para el endpoint API correspondiente de Atlas: https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-createprojectapikey. Para obtener más información sobre los roles de usuario a nivel de proyecto, consulte: https://dochub.mongodb.org/core/atlas-proj-roles.

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 Atlas CLI, consulta 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

Volver

asignar

borrar