Crear claves API de organizaciones IAM de Mongocli

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 utilizar este comando, hay que autenticarse con una cuenta de usuario o una clave API con el rol de Administrador de la Organización de Usuarios.

Sintaxis

Sintaxis del comando

mongocli iam 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, use la opción -o json.
--role	Cuerdas	true	Rol o roles que deseas asignar a la clave API. Para asignar más de un rol, especifica cada rol con una bandera de rol independiente o especifica todos los roles como una lista separada por comas utilizando una sola bandera de rol. Para aprender qué valores acepta el CLI, consulta el 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/Claves-de-API-Programáticas/operation/createApiKey/.

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil que se usará del 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 organization owner access in the organization with the ID 5a1b39eec902201990f12345:
mongocli organizations apiKeys create --role ORG_OWNER --desc "My API Key" --orgId 5a1b39eec902201990f12345 --output json

Volver

asignar

borrar