Menu Docs
Página inicial do Docs
/ /
MongoDB CLI
/ / / /

convites de projetos de mongocli iam

Nesta página

  • Sintaxe
  • argumentos
  • Opções
  • Opções herdadas
  • Exemplos

Convide o usuário MongoDB especificado para o seu projeto.

Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de administrador do usuário do projeto.

Sintaxe do comando
mongocli iam projects invitations invite <email> [options]
Nome
Tipo
Obrigatório
Descrição
Email
string
true
Endereço de e-mail que pertence ao usuário que você deseja convidar para o projeto.
Nome
Tipo
Obrigatório
Descrição
-h, --help
false
ajuda para convite
-o, --output
string
false
Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON.
--projectId
string
false
String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.
--role
strings
true
Roles do usuário para o projeto associado. Os valores válidos incluem GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, GROUP_READ_ONLY, GROUP_AUTOMATION_ADMIN, GROUP_BACKUP_ADMIN e GROUP_MONITORING_ADMIN.
--teamId
strings
false
Sequência única de 24 dígitos que identifica a equipe.
Nome
Tipo
Obrigatório
Descrição
-P, --profile
string
false
Nome do perfil a ser usado no arquivo de configuração. Para saber mais sobre perfis para MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file.
# Invite the MongoDB user with the email user@example.com to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access:
mongocli iam projects invitations invite user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json

Voltar

descrever