Crie um trigger de banco de dados para seu projeto.
Visualização pública: o subcomando atlas api, 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 feedback em https://feedback.mongodb.com/ fóruns/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.
Se você definir --ldapType, --x509Type, --oidcType e --awsIAMType como NONE, o Atlas autenticará esse usuário por meio do SCRAM-SHA. Para saber mais, consulte https://www.mongodb.com/pt-br/docs/manual/core/security-scram/.
Para usar esse comando, você deve se autenticar com uma conta de usuário ou uma chave de API com a role de proprietário do projeto.
Sintaxe
atlas dbusers create [builtInRole]... [options]
argumentos
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
construídoInRole | string | false | Role integrada do Atlas que você deseja atribuir ao usuário. |
Opções
Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
--awsIAMType | string | false | Método do Amazon Web Services IAM pelo qual o nome de usuário fornecido é autenticado. Os valores válidos são NONE, USER ou role. Se você definir isso como USER ou ROLE, o usuário se autenticará com credenciais do IAM e não precisará de uma senha. Mutualmente exclusivo com --ldapType, --x509Type, --idcType. Este valor é padronizado como "NONE". |
--deleteAfter | string | false | Registro de data/hora na ISO 8601 em UTC, após o qual o Atlas exclui o usuário. |
--desc | string | false | Descrição deste usuário de banco de dados. |
-h, --help | false | ajuda para criar | |
--ldapType | string | false | Método LDAP pelo qual o nome de usuário fornecido é autenticado. Os valores válidos são NONE, USER ou GROUP. Se você definir isso como USER ou GROUP, o usuário se autenticará com o LDAP. Mutualmente exclusivo com --awsIAMType, --x509Type, --oidcType. Este valor é padronizado como "NONE". |
--oidcType | string | false | Método OIDC pelo qual o usuário do banco de dados fornecido é autenticado. Os valores válidos são NONE, USER ou IDP_GROUP. Se você definir isso como USER ou GROUP_ID, o usuário se autenticará com o OIDC. Mutualmente exclusivo com --awsIAMType, --ldapType, --x509Type, --password. Este valor é padronizado como "NONE". |
-o, --output | string | false | Formato de saída. Os valores válidos são JSON, json-path, go-template ou go-template-file. Para ver o resultado completo, use a opção -o JSON. |
-p, --password | string | false | Senha do trigger de banco de dados. Mutuamente exclusivo com --oidcType. |
--projectId | string | false | String hexadecimal que identifica o projeto a ser usado. Esta opção substitui as configurações no arquivo de configuração ou variável de ambiente. |
--role | strings | false | Lista separada por vírgulas que especifica as roles do usuário e os bancos de dados ou collections nos quais as roles se aplicam. O formato das funções é roleName[@dbName[.collection]]. roleName pode ser uma função embutida ou uma função personalizada. dbName e collection são necessários apenas para roles integrados. |
--scope | strings | false | Array de clusters aos quais este usuário tem acesso. |
-u, --username | string | true | Nome de usuário para autenticar no MongoDB. |
--x509Type | string | false | Método X.509 para autenticar o nome de usuário especificado. Os valores válidos incluem NONE,MANAGED e CUSTOMER. Se você definir isso como managed, o usuário se autenticará com um certificado X.509 gerenciado pelo Atlas. Se você definir isso como CUSTOMER, o usuário se autenticará com um certificado X.509 autogerenciado. Mutualmente exclusivo com --awsIAMType, --ldapType, --oidcType. Este valor é padronizado como "NONE". |
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. |
Saída
Se o comando for bem-sucedido, a CLI retornará uma saída semelhante à amostra a seguir. Os valores entre colchetes representam seus valores.
Database user '<Username>' successfully created.
Exemplos
# Create an Atlas database admin user named myAdmin for the project with ID 5e2211c17a3e5a48f5497de3: atlas dbusers create atlasAdmin --username myAdmin --projectId 5e2211c17a3e5a48f5497de3
# Create a database user named myUser with read/write access to any database for the project with ID 5e2211c17a3e5a48f5497de3: atlas dbusers create readWriteAnyDatabase --username myUser --projectId 5e2211c17a3e5a48f5497de3
# Create a database user named myUser with multiple roles for the project with ID 5e2211c17a3e5a48f5497de3: atlas dbusers create --username myUser --role clusterMonitor,backup --projectId 5e2211c17a3e5a48f5497de3
# Create a database user named myUser with multiple scopes for the project with ID 5e2211c17a3e5a48f5497de3: atlas dbusers create --username myUser --role clusterMonitor --scope <REPLICA-SET ID>,<storeName> --projectId 5e2211c17a3e5a48f5497de3