Visualização pública: forneça feedback: remove um usuário da MongoDB Cloud do projeto especificado.
Visualização pública: o subcomando da API atlas, 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 comentários em https://feedback.mongodb.com/forums/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 remover um usuário ativo ou um usuário que ainda não aceitou o convite para se juntar à organização. Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de proprietário do projeto.
Observação: este recurso não pode ser usado para remover usuários pendentes convidados por meio do ponto de extremidade Convidar um usuário do MongoDB Cloud para participar de um projeto obsoleto.
Observação: para remover usuários pendentes ou ativos, utilize a v2-{2025-02-19} ou posterior. Se estiver usando uma versão descontinuada, apenas usuários ativos podem ser removidos.
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/removeprojectuser.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api mongoDbCloudUsers removeProjectUser [options]
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--envelope | envelope | false | Sinalizador que indica se o aplicativo empacota a resposta em um objeto JSON de envelope. Alguns clientes de API não podem acessar os cabeçalhos de resposta HTTP ou o código de status. Para corrigir isso, defina envelope=true na query. Os endpoints que retornam uma lista de resultados usam o objeto de resultados como um envelope. O aplicativo adiciona o parâmetro de status ao corpo da resposta. |
--groupId | string | true | Sequência única de 24dígitos hexadecimais que identifica seu projeto. Use o endpoint [/groups](#tag/Projects/operation/listProjects) para recuperar todos os projetos aos quais o usuário autenticado tem acesso. AVISO: grupos e projetos são termos sinônimos. O ID do seu grupo é igual ao ID do seu projeto. Para grupos existentes, o ID do grupo/projeto permanece o mesmo. O recurso e os endpoints correspondentes usam o termo grupos. |
-h, --help | false | ajuda para removeProjectUser | |
-o, --output | string | false | formato de API preferido, pode ser ["JSON", go-template] Este valor padrão é "JSON". |
--outputFile | 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 prettyprint. | |
--userId | string | true | String única de 24dígitos hexadecimais que identifica o usuário pendente ou ativo no projeto. Se precisar pesquisar o userId de um usuário ou verificar o status de um usuário na organização, use o recurso [Retornar todos os usuários do MongoDB Cloud em um projeto](#tag/ MongoDB-Cloud-Users/operation/listProjectUsers) e filtre por nome de usuário. |
--version | string | false | Versão da API a ser usada ao chamar a chamada da API [opções: "2023-01-01", "2025-02-19"], os padrões para a versão mais recente ou os perfis api_version valor de configuração se definido Este valor padrão é "2025-02-19". |
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. |
Exemplos
atlas api mongoDbCloudUsers removeProjectUser --version 2025-02-19 --groupId 32b6e34b3d91647abb20e7b8 --userId [userId]