Remove um usuário do MongoDB Cloud na organização especificada.
O subcomando atlas api é gerado automaticamente a partir da API de administração do MongoDB Atlas e oferece cobertura completa da API de administração. As funcionalidades 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 ponto de extremidade 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.
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 ponto de extremidade da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/operation-removeorguser.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api mongoDbCloudUsers removeOrgUser [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. |
-h, --help | false | ajuda para removeOrgUser | |
--orgId | /orgs | true | String exclusiva de 24dígitos hexadecimais que identifica a organização que contém seus projetos. Use o endpoint [/orgs](#tag/Organizations/operation/listOrganizations) para recuperar todas as organizações às quais o usuário autenticado tem acesso. |
-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 | ID do usuário | true | String única de 24dígitos hexadecimais que identifica o usuário pendente ou ativo na organização. Se você 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 uma organização](#tag/ MongoDB-Cloud-Users/operation/listOrganizationUsers) e filtre por |
--version | string | false | Versão da API a ser usada ao chamar os pontos de extremidade da Atlas API [opções: "2023-01-01", "2025-02-19"]. Se não for definido pelo usuário, o padrão será a versão mais recente ou o valor de configuração api_version do perfil, se definido. Este valor tem como 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 removeOrgUser --version 2025-02-19 --orgId 4888442a3354817a7320eb61 --userId [userId]