atlas api databaseUsers updateDatabaseUser

O suporte do Atlas CLI para executar comandos com a API de administração do Atlas está em visualização. O recurso e a documentação correspondente podem mudar a qualquer momento durante o período de Pré-visualização. Para saber mais, consulte Recursos de visualização.

Visualização pública: forneça comentários: atualiza um usuário de banco de dados que pertence ao 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.

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, de administrador de gráficos do projeto, de proprietário do processamento de fluxo do projeto ou de administrador do acesso ao banco de dados do projeto.

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/operation-updatedatabaseuser.

Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.

Sintaxe

Sintaxe do comando

atlas api databaseUsers updateDatabaseUser [options]

Opções

Nome	Tipo	Obrigatório	Descrição
--databaseName	$external	true	O banco de dados no qual o usuário de banco de dados se autentica. Os usuários do banco de dados devem fornecer um nome de usuário e um banco de dados de autenticação para fazer login no MongoDB. Se o usuário se autenticar com o Amazon Web Services IAM, x.509, LDAP ou OIDC Workload, esse valor deverá ser $external. Se o usuário se autenticar com SCRAM-SHA ou OIDC Workforce, esse valor deverá ser `admin`.
--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.
--file	string	false	caminho para seu arquivo de solicitação de API. Deixe vazio para usar a entrada padrão - você deve fornecer um ou outro, mas não ambos.
--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 updateDatabaseUser
-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.
--username	string	true	Rótulo legível por humanos que representa o usuário que se autentica no MongoDB. O formato desse rótulo depende do método de autenticação: Authentication Method \| Parameter Needed \| Parameter Value \| username Format \| AWS IAM \| awsIAMType \| ROLE \| <abbr title="Amazon Resource Name">ARN</abbr> \| AWS IAM \| awsIAMType \| USER \| <abbr title="Amazon Resource Name">ARN</abbr> \| x.509 \| x509Type \| CUSTOMER \| [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name \| x.509 \| x509Type \| MANAGED \| [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name \| LDAP \| ldapAuthType \| USER \| [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name \| LDAP \| ldapAuthType \| GROUP \| [RFC 2253](https://tools.ietf.org/html/2253) Distinguished Name \| OIDC Workforce \| oidcAuthType \| IDP_GROUP \| Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP group name \| OIDC Workload \| oidcAuthType \| USER \| Atlas OIDC IdP ID (found in federation settings), followed by a '/', followed by the IdP user name \| SCRAM-SHA \| awsIAMType, x509Type, ldapAuthType, oidcAuthType \| NONE \| Alphanumeric string \|
--version	string	false	Versão da API a ser usada ao chamar a chamada da API [opções: "2023-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 "2023-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.