atlas api mongoDbCloudUsers listGroupUsers

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.

"flattenTeams" : false

false

Indicador que indica si la lista devuelta debe incluir a usuarios que pertenezcan a un equipo con un rol en este proyecto. Es posible que no haya asignado a los usuarios individuales un rol en este proyecto. Si "flattenTeams" : false, este recurso solo devuelve a los usuarios con un rol en el proyecto. Si "flattenTeams" : trueEste recurso devuelve tanto a los usuarios con roles en el proyecto como a los usuarios que pertenecen a equipos con roles en el proyecto.

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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.

false

ayuda para listGroupUsers

false

Bandera que indica si la respuesta devuelve el número total de elementos (totalCount) en larespuesta.

"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 "includeOrgUsers": true, este recurso devuelve tanto los usuarios con roles en el proyecto como los usuarios con acceso implícito al proyecto a través de su rol de organización.

Int

false

Número de elementos que la respuesta retorna por página.

string

false

Señal que indica si se debe filtrar la lista devuelta por el estado de membresía de la organización del usuario. Si excluyes este parámetro, este recurso devuelve tanto los usuarios pendientes como los activos. No es compatible con versiones obsoletas.

string

false

formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json".

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)

Int

false

Número de la página que muestra el conjunto actual del total de objetos que devuelve la respuesta.

false

Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.

string

false

Dirección de correo electrónico para filtrar usuarios. No compatible con versiones obsoletas.

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".