atualização de convites do projeto Atlas
Modifica os detalhes do convite pendente especificado para o seu projeto.
Você pode usar a ID do convite ou o endereço de e-mail do usuário para especificar o convite.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.
Sintaxe
Sintaxe do comando
atlas projects invitations update [invitationId] [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
invitationId | string | false | String exclusiva de 24 dígitos que identifica o convite. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--email | string | false | Endereço de e-mail do usuário. |
-h, --help | false | ajuda para atualização | |
-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 a organização associada. Os valores válidos incluem ORG_OWNER, ORG_MEMBER, ORG_GROUP_CREATOR, ORG_BILLING_ADMIN e ORG_READ_ONLY. A transferência desse sinalizador substitui os dados preexistentes. |
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.
Invitation <Id> updated.
Exemplos
# Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc: atlas projects invitations update 5dd56c847a3e5a1f363d424d --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json
# Modify the invitation for the user with the email address user@example.com to grant GROUP_READ_ONLY access the project with the ID 5f71e5255afec75a3d0f96dc: atlas projects invitations update --email user@example.com --projectId 5f71e5255afec75a3d0f96dc --role GROUP_READ_ONLY --output json