atlas api mongoDbCloudUsers getUser

Devuelve los detalles de una cuenta de usuario de MongoDB nube con el identificador único especificado para el usuario.

El subcomando atlas api se genera automáticamente desde la API de administración de MongoDB Atlas y ofrece cobertura completa de dicha API. 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.

No puede usar este punto de conexión para devolver información sobre una clave API. Para ello, utilice el punto de conexión "Devolver una clave API de organización". Siempre puede recuperar su propia cuenta de usuario. Si es propietario de una organización o proyecto de MongoDB Cloud, también puede recuperar el perfil de cualquier usuario miembro de dicha organización o proyecto. Para usar este recurso, la cuenta de servicio o la clave API solicitantes pueden tener cualquier rol.

Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getuser.

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 mongoDbCloudUsers getUser [options]

opciones

Nombre	Tipo	Requerido	Descripción
--envelope	envelope	false	Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. 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.
-h, --help		false	ayuda para getUser
-o, --output	string	false	formato de API preferido, puede ser ["json", go-template] Este valor predeterminado 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)
--bonito		false	Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
--userId	string	true	Cadena única de 24 dígitos hexadecimales que identifica a este usuario.
--versión	string	false	versión de la API que se utilizará al llamar a la llamada de API [opciones: "2023-01-01"], por defecto se usa la versión más reciente o el valor de configuración api_version de perfiles si se establece Este valor por defecto es "2023-01-01".

Opciones heredadas

Nombre	Tipo	Requerido	Descripción
-P, --profile	string	false	Nombre del perfil que se utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings.

Volver

getOrgUser

getUserByName