Devuelve detalles sobre los usuarios de MongoDB Cloud pendientes y activos asociados con el proyecto especificado.
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 la función de solo lectura del proyecto.
Nota: Este recurso no se puede usar para ver detalles sobre los usuarios invitados a través del punto final obsoleto Invitar a un usuario de MongoDB Cloud a unirse a un proyecto.
Nota: Para devolver tanto los usuarios pendientes como los activos, utilice la versión v2-{2025-02-19} o posterior. Si utiliza una versión obsoleta, solo se devolverán los usuarios activos.
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-listgroupusers.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api mongoDbCloudUsers listGroupUsers [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. |
--aplanarEquipos | "flattenTeams": falso | false | Marca que indica si la lista devuelta debe incluir usuarios que pertenecen a un equipo con un rol en este proyecto. Es posible que no haya asignado un rol a los usuarios individuales en este proyecto. Si "flattenTeams" es falso, este recurso devuelve solo usuarios con un rol en el proyecto. Si |
--ID de grupo | string | true | Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos". |
-h, --ayuda | false | ayuda para listGroupUsers | |
--incluirConteo | false | Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta. | |
--includeOrgUsers | "includeOrgUsers": falso | false | Marca que indica si la lista devuelta debe incluir usuarios con acceso implícito al proyecto, el rol de Propietario de la Organización o el rol de Solo Lectura de la Organización. Es posible que no haya asignado un rol a los usuarios individuales en este proyecto. Si "includeOrgUsers": false, este recurso devuelve solo los usuarios con un rol en el proyecto. Si |
--itemsPerPage | Int | false | Número de elementos que la respuesta devuelve por página. |
--orgEstado de membresía | string | false | Indicador que indica si se debe filtrar la lista devuelta por el estado de pertenencia a la organización de los usuarios. Si se excluye este parámetro, este recurso devuelve tanto los usuarios pendientes como los activos. No compatible con versiones obsoletas. |
-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) |
--Número de página | Int | false | Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta. |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint. | |
--username | string | false | Dirección de correo electrónico para filtrar usuarios. No compatible con versiones obsoletas. |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01", "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 listGroupUsers --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --orgMembershipStatus ACTIVE