- 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: Cria um usuário de banco de dados no projeto especificado .
O MongoDB Cloud permite um máximo de 100 usuários de banco de dados por projeto. Se precisar de mais de 100 usuários de banco de dados em um projeto, entre em contato com o Suporte. Para usar esse recurso, a chave de API solicitante deve ter a role de proprietário do projeto, administrador de Charts do projeto, proprietário de processamento de fluxo de projetos ou administrador de 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/atlas/reference/api-resources-spec/v2/#tag/Database-Usuários/operation/createDatabaseUser.
Para obter mais informações e exemplos, consulte a documentação da API referenciada acima.
Sintaxe
atlas api databaseUsers createDatabaseUser [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. |
--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 createDatabaseUser | |
--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 <a URL =https://en.wikipede.org/wiki/Prettyprint" formato target="_blank" rel="noopener noreferrer">pretty-print</a>. | |
--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
Autenticação LDAP
Crie o arquivo abaixo e salve-o como payload.json
{ "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "ldapAuthType": "GROUP", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "CN=marketing,OU=groups,DC=example,DC=com" }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
Autenticação federada da força de trabalho com o OIDC
Crie o arquivo abaixo e salve-o como payload.json
{ "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "oidcAuthType": "IDP_GROUP", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "5dd7496c7a3e5a648454341c/sales" }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
Autenticação federada de carga de trabalho com o OIDC
Crie o arquivo abaixo e salve-o como payload.json
{ "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", "oidcAuthType": "USER", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "5dd7496c7a3e5a648454341c/sales" }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
Autenticação SCRAM-SHA
Crie o arquivo abaixo e salve-o como payload.json
{ "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "password": "changeme123", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "david" }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false
Autenticação X509
Crie o arquivo abaixo e salve-o como payload.json
{ "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "CN=david@example.com,OU=users,DC=example,DC=com", "x509Type": "CUSTOMER" }
Após criar o payload.json, execute o comando abaixo no mesmo diretório.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --envelope false --groupId 32b6e34b3d91647abb20e7b8 --pretty false