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

convite para usuários do Atlas

Nesta página

  • Sintaxe
  • Opções
  • Opções herdadas
  • Saída
  • Exemplos

Crie um Atlas user para seu aplicativo MongoDB Atlas e Convide o Atlas user para suas organizações e projetos.

Uma conta de Atlas user concede acesso somente ao aplicação do MongoDB Atlas . Para conceder acesso ao banco de dados de dados, crie um usuário de banco de dados de dados com Atlas dbusers create.

Sintaxe do comando
atlas users invite [options]
Nome
Tipo
Obrigatório
Descrição
--country
string
true
Código alfabético de duas letras ISO 3166-1 da localização geográfica do usuário. O Atlas CLI exige esta opção.
--email
string
true
Endereço de e-mail do usuário.
--firstName
string
true
Nome próprio do usuário.
-h, --help
false
ajuda para convite
--lastName
string
true
Sobrenome, nome de família ou sobrenome do usuário.
-- mobile
string
false
Número de celular do usuário.
--orgRole
strings
false
String exclusiva de 24 dígitos que identifica a organização, dois pontos e a role do usuário para a organização. Especifique este valor como orgID:ROLE. Os valores válidos para role incluem ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN e ORG_READ_ONLY.
-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.
--password
string
false
Senha para o usuário.
--projectRole
strings
false
String única de 24 dígitos que identifica o projeto, dois pontos e a função do usuário no projeto. Especifique este valor como projectID:ROLE. Os valores válidos para role incluem GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER e GROUP_READ_ONLY.
--username
string
true
Nome que identifica o usuário. Você deve especificar um endereço de e-mail válido.
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.

Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.

The user '<Username>' has been invited.
Invited users do not have access to the project until they accept the invitation.
# Create the Atlas user with the username user@example.com and invite them to the organization with the ID 5dd56c847a3e5a1f363d424d with ORG_OWNER access:
atlas users invite --email user@example.com --username user@example.com --orgRole 5dd56c847a3e5a1f363d424d:ORG_OWNER --firstName Example --lastName User --country US --output json
# Create the Atlas user with the username user@example.com and invite them to the project with the ID 5f71e5255afec75a3d0f96dc with GROUP_READ_ONLY access:
atlas users invite --email user@example.com --username user@example.com --projectRole 5f71e5255afec75a3d0f96dc:GROUP_READ_ONLY --firstName Example --lastName User --country US --output json

Voltar

descrever