Devuelve información sobre el usuario de MongoDB Cloud especificado dentro del contexto de la organización especificada.
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.
Para utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de miembro de la organización.
Nota: Este recurso solo se puede usar para obtener información sobre usuarios humanos de MongoDB Cloud. Para obtener información sobre una clave API, utilice el punto de conexión "Devolver una clave API de organización".
Nota: Este recurso no devuelve información sobre los usuarios pendientes invitados a través del punto final obsoleto Invitar a un usuario de MongoDB Cloud a unirse a un proyecto.
Este comando se genera automáticamente y corresponde 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-getorguser.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api mongoDbCloudUsers getOrgUser [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--sobre | envolvente | 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, --ayuda | false | ayuda para getOrgUser | |
--orgId | string | true | Cadena única de dígitos hexadecimales 24que identifica la organización que contiene sus proyectos. Utilice el punto de conexión [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--archivo de salida | 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 formato prettyprint. | |
--userId | string | true | Cadena única de dígitos hexadecimales 24que identifica al usuario pendiente o activo en la organización. Si necesita consultar el ID de usuario de un usuario o verificar su estado en la organización, utilice el recurso "Devolver todos los usuarios de MongoDB Cloud en una organización" y filtre por nombre de usuario. |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2025-02-19"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2025-02-19". |
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. |
Ejemplos
atlas api mongoDbCloudUsers getOrgUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]