Menu Docs
Página inicial do Docs
/
MongoDB Atlas
/
Atlas CLI
/
Comandos
/
API
/
databaseUsers

atlas API databaseUsers createDatabaseUser

Visualização pública: forneça comentários: cria um usuário de banco de dados no projeto especificado.

O subcomando da API do 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.

Este MongoDB Cloud suporta 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 conta de serviço ou a chave API solicitante deve ter a função de proprietário do projeto, a função de administrador de gráficos do projeto, a função de proprietário do processamento de fluxo do projeto ou a função de administrador de acesso ao banco de dados do projeto.

Este comando é gerado automaticamente e 1 corresponde:1 ao endpoint da API do Atlas https://www.mongodb.com/pt-br/docs/api/doc/atlas-admin-api-v2/operation/createdatabaseuser .

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

Sintaxe

Sintaxe do comando
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

-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.

--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

AWS Autenticação do IAM

Crie o arquivo abaixo e salve-o como payload.json

{
  "awsIAMType": "USER",
  "databaseName": "$external",
  "groupId": "32b6e34b3d91647abb20e7b8",
  "roles": [
    {
      "databaseName": "sales",
      "roleName": "readWrite"
    },
    {
      "databaseName": "marketing",
      "roleName": "read"
    }
  ],
  "scopes": [
    {
      "name": "myCluster",
      "type": "CLUSTER"
    }
  ],
  "username": "arn:aws:iam::358363220050:user/mongodb-aws-iam-auth-test-user"
}

Após criar o payload.json, execute o comando abaixo no mesmo diretório.

atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8

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 --groupId 32b6e34b3d91647abb20e7b8

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 --groupId 32b6e34b3d91647abb20e7b8

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 --groupId 32b6e34b3d91647abb20e7b8

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 --groupId 32b6e34b3d91647abb20e7b8

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 --groupId 32b6e34b3d91647abb20e7b8

Voltar

databaseUsers

Próximo

deleteDatabaseUser

Nesta página