Docs Menu
Docs Home
/ /

Los usuarios de Atlas describen

Devuelve los detalles del usuario de base de datos especificado para tu proyecto.

Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con la función de solo lectura del proyecto.

Sintaxis del comando
atlas dbusers describe <username> [options]
Nombre
Tipo
Requerido
Descripción

Nombre de usuario

string

true

Nombre de usuario que se recuperará de la base de datos MongoDB. El formato del nombre de usuario depende del método de autenticación del usuario.

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. El valor predeterminado es "admin".

-h, --ayuda

false

ayuda para describir

-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.

--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.

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 para la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.

USERNAME DATABASE
<Username> <DatabaseName>
# Return the details for the SCRAM SHA-authenticating database user named myDbUser:
atlas dbuser describe myDbUser --authDB admin --output json
# Return the details for the AWS IAM-authenticating database user with the ARN arn:aws:iam::772401394250:user/my-test-user. Prepend $external with \ to escape the special-use character:
atlas dbuser describe arn:aws:iam::772401394250:user/my-test-user --authDB \$external --output json
# Return the details for the X.509-authenticating database user with the RFC 2253 Distinguished Name CN=ellen@example.com,OU=users,DC=example,DC=com. Prepend $external with \ to escape the special-use character:
atlas dbuser describe CN=ellen@example.com,OU=users,DC=example,DC=com --authDB \$external --output json

Volver

borrar

En esta página