Docs Menu
Docs Home
/ /

Cuentas de servicio de la API de Atlas, cuenta de servicio de grupo de invitación

Asigna la cuenta de servicio especificada al proyecto especificado.

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.

Este comando se genera automáticamente y corresponde 1:1 con el punto final de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/operation-invitegroupserviceaccount.

Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.

Sintaxis del comando
atlas api serviceAccounts inviteGroupServiceAccount [options]
Nombre
Tipo
Requerido
Descripción

--clientId

string

true

El ID de cliente de la cuenta de servicio.

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

--file

string

false

Ruta a tu archivo de solicitud de API. Déjalo en blanco para usar la entrada estándar; debes proporcionar una u otra, pero no ambas.

--ID de grupo

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 de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos".

-h, --ayuda

false

Ayuda para inviteGroupServiceAccount

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

--bonito

false

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

--versión

string

false

Versión de API a utilizar al llamar a la llamada de API [opciones: "2024-08-05"], 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 "2024-08-05".

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.

Volver

obtenerGruposDeCuentasDeServicio

En esta página