atualização de convites de organizações de mongocli iam
Modifica os detalhes do convite pendente especificado para a sua organização.
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 autenticar com uma conta de usuário ou uma chave de API com a role Proprietário da organização.
Sintaxe
Sintaxe do comando
mongocli iam organizations 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 | |
--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/. A passagem deste 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 MongoCLI, consulte https://dochub.mongodb.org/core/atlas-cli-configuration-file. |
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 ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: mongocli iam organizations invitations update 5dd56c847a3e5a1f363d424d --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json
# Modify the invitation for the user with the email address user@example.com to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc: mongocli iam organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json