- Esta versão da documentação foi arquivada e não é mais suportada. Consulte adocumentação atual do para saber como atualizar sua versão da Atlas CLI.
Visualização pública: forneça comentários em: retorna um usuário de banco de dados que pertence ao projeto especificado.
Para usar esse recurso, a conta de serviço ou a chave de API solicitante deve ter a função de "somente leitura" do projeto.
Este comando é gerado automaticamente e corresponde 1:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/getDatabaseUser.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api databaseUsers getDatabaseUser [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 |
--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 getDatabaseUser | |
-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. |
Exemplos
atlas api databaseUsers getDatabaseUser --version 2023-01-01 --databaseName [databaseName] --groupId 32b6e34b3d91647abb20e7b8 --username SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName