experimental: remove um usuário do MongoDB Cloud de uma equipe.
Você pode remover 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: esse recurso não pode ser usado para remover um usuário convidado por meio do obsoleto endpoint Convide um usuário do MongoDB Cloud para participar de um projeto. Este comando está invocando o endpoint com OperationID: 'removeUserFromTeam'. 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/operação/removeUserFromTeam
Sintaxe
atlas api mongoDbCloudUsers removeUserFromTeam [options]
Opções
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 removeUserFromTeam | |
--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 | |
--teamId | string | true | sequência exclusiva de dígitos hexadecimais 24que identifica a equipe para remover o usuário MongoDB de |
--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". |
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. |