atualização de convites de organização do Atlas

Modifica os detalhes do convite pendente especificado para a sua organização.

Visualização pública: o subcomando atlas api, gerado automaticamente a partir da API de administração do MongoDB Atlas , oferece cobertura completa da API de administração e está atualmente em visualização pública (forneça feedback em https://feedback.mongodb.com/ fóruns/930808-atlas-cli). Os recursos da API de administração têm seu próprio ciclo de vida de versão, que você pode verificar por meio do link de documentação do endpoint da API fornecido.

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

atlas 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.
-f, --file	string	false	Caminho para um arquivo de configuração JSON opcional que define as configurações do convite. Observação: os campos não suportados no arquivo JSON são ignorados. Mutualmente exclusivo com --role.
-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	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. A transferência desse sinalizador substitui os dados preexistentes. 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.

Invitation <Id> updated.

Exemplos

# Modify the pending invitation with the ID 5dd56c847a3e5a1f363d424d to grant ORG_OWNER access the organization with the ID 5f71e5255afec75a3d0f96dc:
atlas 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:
atlas organizations invitations update --email user@example.com --orgId 5f71e5255afec75a3d0f96dc --role ORG_OWNER --output json

Voltar

Lista