- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Modifique los detalles de un usuario de la base de datos en su proyecto.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Para usar este comando, debes autenticarte con una cuenta de usuario o una clave de API con el rol de Propietario de Proyecto.
Sintaxis
atlas dbusers update <username> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
Nombre de usuario | string | true | Nombre de usuario para actualizar en la base de datos MongoDB. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--authDB | string | false | Nombre de la base de datos de autenticación. Si el usuario se autentica con AWS IAM, x.509 o LDAP, este valor debe ser $external. Si se autentica con SCRAM-SHA, este valor debe ser admin. |
--desc | string | false | Descripción de este usuario de base de datos. |
-h, --ayuda | false | ayuda para actualizar | |
-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. |
-p, --password | string | false | Contraseña para el usuario de la base de datos. |
--projectId | string | false | Cadena hexadecimal que identifica el proyecto que se utilizará. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
--role | cadenas | false | Roles de usuario y bases de datos o colecciones donde se aplican. Al pasar esta bandera, se reemplazan los datos preexistentes. |
--scope | cadenas | false | Matriz de clústeres a los que este usuario tiene acceso. Al pasar esta bandera, se reemplazan los datos preexistentes. |
-u, --username | string | false | Nombre de usuario para autenticarse en MongoDB. |
--x509Type | string | false | Método X.509 para autenticar el nombre de usuario especificado. Los valores válidos son NONE, MANAGED y CUSTOMER. Si se configura como MANAGED, el usuario se autentica con un certificado X.509 administrado por Atlas. Si se configura como CUSTOMER, el usuario se autentica con un certificado X.509 autoadministrado. El valor predeterminado es "NONE". |
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.
Successfully updated database user '<Username>'.
Ejemplos
# Update roles for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: atlas dbuser update myUser --role readWriteAnyDatabase --projectId 5e2211c17a3e5a48f5497de3
# Update scopes for a database user named myUser for the project with the ID 5e2211c17a3e5a48f5497de3: atlas dbuser update myUser --scope resourceName:resourceType --projectId 5e2211c17a3e5a48f5497de3