atlas organizaciones apiKeys create

Cree una clave de API para su organización.

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, una cuenta de servicio o una clave de API con el rol de Administrador de usuarios de la organización.

Sintaxis

Sintaxis del comando

atlas organizations 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
--orgId	string	false	Identificador de la Organización a usar. Esta opción anula la configuración en el 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, usa la opción -o json.
--role	Cuerdas	true	Rol o roles que desea asignar a la clave API. Para asignar más de un rol, especifique cada rol con un indicador de rol independiente o especifique todos los roles como una lista separada por comas usando un solo indicador de rol. Para ver la lista completa de valores aceptados, consulte la enumeración Items para el punto final de la API de Atlas correspondiente: https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/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 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 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

Volver

asignar

borrar