Devuelve detalles sobre los usuarios pendientes y activos de MongoDB nube asociados a 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 usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de miembro de la organización.
Nota: Este recurso no puede utilizarse para ver detalles sobre los usuarios invitados mediante el ya obsoleto endpoint Invitar a un usuario de MongoDB Cloud a unirse a un proyecto.
Nota: para mostrar tanto usuarios pendientes como activos, usa v2-{2025-02-19} o posterior. Si se utiliza una versión obsoleta, solo se devolverán los usuarios activos.
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-listorgusers.
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 listOrgUsers [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 listOrgUsers | |
--includeCount | false | Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta. | |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
--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. |
--Estado de afiliación a la organización | string | false | Estado de pertenencia a la organización por el que filtrar a los usuarios. Si omite este parámetro, este recurso devuelve tanto los usuarios pendientes como los activos. No se admite en versiones obsoletas. |
-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) |
--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 el 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 la api a utilizar al llamar a la llamada api [opciones: "2023-01-01", "2025-02-19"], por defecto se utilizará la última versión o el valor de configuración api_version de los perfiles si se establece. Este valor tiene como valor por defecto "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 listOrgUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE