Cree una clave 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, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con el rol de administrador de usuario de la organización.
Sintaxis
atlas organizations apiKeys create [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--desc | string | true | Descripción de la clave API. |
-h, --ayuda | 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 | cadenas | 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/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 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, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus 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