Para agentes de IA: hay un índice de documentación disponible en https://www.mongodb.com/es/docs/llms.txt — versiones en markdown de todas las páginas están disponibles agregando .md a cualquier ruta URL.
Devuelve un usuario de base de datos que pertenece al proyecto especificado.
El subcomando del atlas api se genera automáticamente a partir de la API de administración de MongoDB Atlas y ofrece una cobertura total de la API de administración. Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puedes consultar a través del enlace a la documentación del endpoint de la API proporcionada.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
Sintaxis del comando
atlas api databaseUsers getDatabaseUser [options]
opciones
Nombre
Tipo
Requerido
Descripción
--databaseName
$external
true
La base de datos contra la cual el usuario de base de datos se autentica. Los usuarios de bases de datos deben proporcionar tanto un nombre de usuario como una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP o OIDC carga de trabajo, este valor debe establecerse en $external. Si el usuario se autentica con SCRAM-SHA u OIDC Workforce, este valor debería ser admin.
--envelope
envelope
false
Indicador que señala si la Aplicación envuelve la respuesta en un objeto JSON de envoltorio. Algunos clientes de API no pueden acceder a las cabeceras de respuesta HTTP o al código de estado. Para remediarlo, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta.
--groupId
string
true
string hexadecimal única de 24dígitos que identifica tu proyecto. Utiliza el punto final [/groups](#tag/Projects/operation/listProjects) para recuperar todos los proyectos a los que el usuario autenticado tiene acceso.
NOTA: Grupos y proyectos son términos sinónimos. El id de tu grupo es el mismo que el id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
-h, --help
false
ayuda para getDatabaseUser
-o, --output
string
false
formato API preferido, puede ser ["JSON", plantilla-go] Este valor por defecto es "JSON".
--outputFile
string
false
archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip)
--bastante
false
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
--username
awsIAMType
true
etiqueta legible por humanos que representa al usuario que se autentica en MongoDB. El formato de esta etiqueta depende del método de autenticación:
Método de autenticación | Parámetro necesario | Valor del parámetro | Formato de nombre de usuario |
AWS IAM | awsIAMType | ROLE | ARN</abbr> | AWS IAM | awsIAMType | USER | ARN</abbr> | x.509 | x509Type | CUSTOMER | [RFC 2253](https://tools.ietf.org/html/2253) Nombre distinguido | x.509 | x509Type | MANAGED | [RFC 2253](https://tools.ietf.org/html/2253) Nombre distinguido | LDAP | ldapAuthType | USER | [RFC 2253]( https://tools.ietf.org/html/2253 ) Nombre distinguido | LDAP | ldapAuthType | GROUP | [RFC 2253]( https://tools.ietf.org/html/2253 ) Nombre distinguido | Fuerza laboral de OIDC | oidcAuthType | IDP_GROUP | ID de IdP de Atlas OIDC (se encuentra en la configuración de federación), seguido de una '/', seguido del nombre del grupo de IdP | Carga de trabajo de OIDC | oidcAuthType | USER | ID de IdP de Atlas OIDC (se encuentra en la configuración de federación), seguido de una '/', seguido del nombre de usuario de IdP | SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType | NONE | Cadena alfanumérica
|
--versión
string
false
Versión de la API que se debe usar al llamar a los endpoints de la API de Atlas [opciones: "2023-01-01"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se establece por defecto en "2023-01-01".