Elimina un usuario de MongoDB Cloud en 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.
Puede remover un usuario activo o un usuario que aún no ha aceptado la invitación para unirse a la organización. Para usar este recurso, la Cuenta de servicio o API Key solicitante debe tener el rol de Propietario de la organización.
Nota: Este recurso no se puede utilizar para remover usuarios pendientes que hayan sido invitados a través del endpoint obsoleto Invitar a un usuario de MongoDB nube a unirse a un Proyecto.
Nota: Para eliminar usuarios pendientes o activos, use la versión2-{2025-02-19} o posterior. Si usa una versión obsoleta, solo se pueden eliminar 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-removeorguser.
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 removeOrgUser [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 removeOrgUser | |
--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. |
-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) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint. | |
--userId | string | true | string única 24de dígitos hexadecimales que identifica al usuario pendiente o activo en la organización. Si necesitas buscar el userId de un usuario o verificar el estado de un usuario en la organización, usa el recurso [Devolver Todos los Usuarios de MongoDB Cloud en Una Organización](#tag/MongoDB-Cloud-Users/operation/listOrganizationUsers) y filtra por nombre de usuario. |
--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 removeOrgUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]