convites da organização Atlas
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
atlas organizations invitations invite <email> [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
string | true | Endereço de e-mail que pertence ao usuário que você deseja convidar para a organização. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
-f, --file | string | false | Caminho para um arquivo de configuração JSON opcional que define as configurações do convite. Para saber mais sobre arquivos de configuração de convite para Atlas CLI, consulte https://XXX. Mutualmente exclusivo com --role, --teamId. |
-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 | false | Roles do usuário para a organização associada. Os valores válidos incluem ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN e ORG_READ_ONLY. Mutuamente exclusivo com --file. |
--teamId | strings | false | Sequência única de 24 dígitos que identifica a equipe. Mutuamente exclusivo com --file. |
Opções herdadas
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 o Atlas CLI, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
User '<Username>' invited.
Exemplos
# 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