atlas api mongoDbCloudUsers listOrgUsers

--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 listOrgUsers

--includeCount

totalCount

false

Indicador que señala si la respuesta retorna el número total de ítems (totalCount) en la respuesta.

--itemsPerPage

Int

false

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

--orgId

/orgs

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

orgMembershipStatuses

false

Obsoleto: Utiliza orgMembershipStatuses en su lugar. Estado de membresía de la organización para filtrar usuarios. Valores permitidos: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Si omites este parámetro, este recurso devuelve usuarios ACTIVOS y PENDIENTES. No compatible con versiones obsoletas.

--orgMembershipStatuses

Activo

false

Estado de membresía en la organización por el cual se filtrarán los usuarios. Puede proporcionar este parámetro varias veces. Valores permitidos: ACTIVE, PENDING, INVITATION_EXPIRED, INVITATION_REJECTED. Sustituye al parámetro obsoleto orgMembershipStatus. Si excluyes este parámetro, este recurso devuelve usuarios ACTIVOS y PENDIENTES. No se puede combinar con orgMembershipStatus. No es compatible con 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.

--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 que se debe usar al llamar a los endpoints de la API de Atlas [opciones: "2023-01-01", "2025-02-19"]. Si el usuario no lo configura, por defecto se utiliza la última versión o el valor de configuración api_version del perfil si se ha configurado. Este valor se establece por defecto en "2025-02-19".