- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Vista previa pública: por favor, proporciona comentarios: Devuelve los detalles de una invitación pendiente a la organización especificada.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). 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 utilizar este recurso, la cuenta de servicio o la clave API solicitante debe tener el rol de propietario de la organización.
Nota: Las API de gestión de invitaciones están obsoletas. Utilice "Devolver un usuario de MongoDB Cloud en una organización" para devolver un usuario pendiente.
Este comando se genera automáticamente y 1 corresponde:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#tag/Organizations/operation/getOrganizationInvitation.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api organizations getOrganizationInvitation [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--sobre | envolvente | 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, --ayuda | false | Ayuda para obtener una invitación de la organización | |
--invitationId | string | true | Cadena única de 24 dígitos hexadecimales que identifica la invitación. |
--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". |
--archivo de salida | 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) |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
atlas api organizations getOrganizationInvitation --version 2023-01-01 --invitationId [invitationId] --orgId 4888442a3354817a7320eb61