Invite al usuario de MongoDB especificado a su organización.
Para utilizar este comando, hay que autenticarse con una cuenta de usuario o una clave API con el rol de Administrador de la Organización de Usuarios.
Sintaxis
mongocli iam 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 deseas invitar a la organización. |
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-h, --help | false | ayuda para invitación | |
--orgId | string | false | Identificador de la Organización a usar. Esta opción anula la configuración en el 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, usa la opción -o json. |
--role | Cuerdas | true | Roles del usuario para la organización asociada. Para aprender qué valores acepta MCLI, consulta el Enum de elementos para roles en la especificación de la API de Atlas: https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/. |
--teamId | Cuerdas | false | Unique 24-digit string que identifica al equipo. |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará del archivo de configuración. Para aprender sobre los perfiles para MongoCLI, consulta https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
Ejemplos
# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access: mongocli organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json