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

convites de organizações de mongocli iam

Nesta página

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

Convide o usuário MongoDB especificado para sua organização.

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 da organização.

Sintaxe do comando
mongocli iam organizations 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 a organização.

Nome
Tipo
Obrigatório
Descrição

-h, --help

false

ajuda para convite

--orgId

string

false

ID da organização a ser usada. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente.

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

--role

strings

true

Roles do usuário para a organização associada. Para saber quais valores o MCLI aceita, consulte o Enum de itens para roles na especificação da API do Atlas: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/#operation/createOrganizationInvitation/.

--teamId

strings

false

Sequência única de 24 dígitos que identifica a equipe.

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

# Invite the MongoDB user with the email user@example.com to the organization with the ID 5f71e5255afec75a3d0f96dc with ORG_OWNER access:
mongocli iam organizations invitations invite user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json

Voltar

descrever