Join us Sept 17 at .local NYC! Use code WEB50 to save 50% on tickets. Learn more >
MongoDB Event
Menu Docs
Página inicial do Docs
/ /
Atlas CLI
/ / /

atlas api mongoDbCloudUsers updateOrganizationUser

experimental: Atualiza um usuário do MongoDB Cloud na organização especificada .

Você pode atualizar um usuário ativo ou um usuário que ainda não aceitou o convite para participar da organização. Para usar esse recurso, a chave de API solicitada deve ter a função "Proprietário da organização". Observação: inclua apenas os campos que você deseja atualizar no corpo da solicitação. Fornecer um campo com um valor vazio redefinirá esse campo no usuário. Observação: esse recurso não pode ser usado para atualizar usuários pendentes convidados por meio do endpoint obsoleto Convide um usuário do MongoDB Cloud para participar de um projeto. Este comando está invocando o endpoint com OperationID: 'updateOrganizationUser'. Para obter mais informações sobre sinalizadores, formato de --file e exemplos, consulte: https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/MongoDB-Cloud-Usuários/operation/updateOrganizationUser

Sintaxe do comando
atlas api mongoDbCloudUsers updateOrganizationUser [options]
Nome
Tipo
Obrigatório
Descrição

--envelope

false

sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope

--file

string

false

caminho para o arquivo que contém o conteúdo da solicitação de API

-h, --help

false

ajuda para updateOrganizationUser

--orgId

string

true

string exclusiva de dígitos hexadecimais 24que identifica a organização que contém seus projetos

--output

string

false

formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON".

--output-file

string

false

no qual gravar a saída da API. Esse sinalizador é necessário quando a saída de um endpoint é binária (por exemplo: gzip) e o comando não é piped (por exemplo: comando atlas > out.zip)

--pretty

false

sinalizador que indica se o corpo da resposta deve estar no formato de impressão bonita

--userId

string

true

string exclusiva de 24dígitos hexadecimais que identifica o usuário pendente ou ativo na organização

--version

string

false

Versão da API a ser usada ao chamar a chamada da API [opções: "2043-01-01"], o padrão é a versão mais recente ou o valor de configuração dos perfis api_version, se definido Este valor é padronizado como "2043-01a01".

Nome
Tipo
Obrigatório
Descrição

-P, --profile

string

false

Voltar

removeUserFromTeam

Nesta página