Devuelve información sobre el usuario de MongoDB nube especificado dentro del contexto de la organización especificada.
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 usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de miembro de la organización.
Nota: Este recurso sólo puede utilizarse para obtener información sobre los usuarios humanos de MongoDB Cloud. Para devolver información sobre una clave de API, utilice el endpoint Devolver una clave de API de la organización.
Nota: Este recurso no devuelve información sobre usuarios pendientes invitados a través del obsoleto endpoint Invitar a un usuario de MongoDB Cloud a unirse a un proyecto.
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/operación/operación-getorguser.
Para obtener más información y ejemplos, consulta la documentación de la API referenciada que se encuentra en el enlace anterior.
Sintaxis
atlas api mongoDbCloudUsers getOrgUser [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--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. |
-h, --help | false | ayuda para getOrgUser | |
--orgId | string | true | string única de 24dígitos hexadecimales que identifica a la organización que contiene los proyectos. Use el endpoint [/orgs](#etiqueta/Organizations/operación/listOrganizations) para recuperar todas las organizaciones a las que el usuario autenticado tiene acceso. |
-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. | |
--userId | string | true | string única de 24dígitos hexadecimales que identifica al usuario pendiente o activo en la organización. Si necesitas buscar el ID de usuario de un usuario o verificar el estado de un usuario en la organización, utiliza el recurso Devolver todos los usuarios de la organización en MongoDB nube y filtra por nombre de usuario. |
--versión | string | false | versión de la API que se utilizará al llamar a la llamada de API [opciones: "2025-02-19"], 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 "2025-02-19". |
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. |
Ejemplos
atlas api mongoDbCloudUsers getOrgUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]