Devuelve detalles sobre los usuarios pendientes y activos de MongoDB nube asociados con el equipo especificado en la organización.
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.
Los equipos te permiten conceder roles de acceso a proyectos a los usuarios de MongoDB Cloud. Para usar este recurso, la Cuenta de Servicio solicitante o la Clave API debe tener el rol de nodo 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/operación/operación-listorgteamusers.
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 listTeamUsers [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 listTeamUsers | |
--itemsPerPage | Int | false | Número de elementos que la respuesta retorna por página. |
--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. |
--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 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) |
--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. |
--bastante | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--teamId | string | true | string única de 24 dígitos hexadecimales que identifica el equipo cuyos usuarios de aplicación deseas recuperar. |
--userId | string | false | String única de dígitos hexadecimales 24para filtrar los usuarios. No es compatible con versiones obsoletas. |
--username | string | false | Dirección de correo electrónico para filtrar usuarios. No es compatible con versiones en desuso. |
--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 listTeamUsers --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --orgMembershipStatus ACTIVE --teamId [teamId]