Invita al usuario MongoDB especificado a tu organización.
Para utilizar este comando, debe autenticarse con una cuenta de usuario, una cuenta de servicio o una clave API con el rol de administrador de usuario de la organización.
Sintaxis
atlas organizations invitations invite <email> [options]
Arguments
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
correo electrónico | string | true | Dirección de correo electrónico que pertenece al usuario que desea invitar a la organización. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-f, --file | string | false | Ruta a un archivo de configuración JSON opcional que define la configuración de la invitación. Nota: Los campos no admitidos en el archivo JSON se ignoran. Mutuamente excluyente con --role, --teamId. |
-h, --ayuda | false | ayuda para invitar | |
--orgId | string | false | ID de organización a utilizar. Esta opción anula la configuración del archivo de configuración o la variable de entorno. |
-o, --output | string | false | Formato de salida. Los valores válidos son json, json-path, go-template o go-template-file. Para ver la salida completa, use la opción -o json. |
--role | cadenas | false | Roles del usuario para la organización asociada. Los valores válidos son ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN y ORG_READ_ONLY. Mutuamente excluyente con --file. |
--teamId | cadenas | false | Cadena única de 24dígitos que identifica al equipo. Mutuamente excluyente con --file. |
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 para la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Salida
Si el comando se ejecuta correctamente, la CLI devuelve un resultado similar al siguiente ejemplo. Los valores entre paréntesis representan sus valores.
User '<Username>' invited.
Ejemplos
# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: atlas organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json