- Esta versión de la documentación está archivada y ya no se admite. Ver la Documentación actual para aprender cómo actualizar su versión de Atlas CLI.
Vista previa pública: proporcione comentarios: crea un usuario de base de datos en el proyecto especificado.
Vista previa pública: El subcomando atlas api, generado automáticamente desde la API de administración de MongoDB Atlas, ofrece cobertura completa de la API de administración y se encuentra actualmente en vista previa pública (envíe sus comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la API de administración tienen su propio ciclo de vida de lanzamiento, que puede consultar a través del enlace de documentación del punto final de la API.
Esta nube de MongoDB admite un máximo de 100 usuarios de base de datos por proyecto. Si necesita más de 100 usuarios de base de datos en un proyecto, contacte con el equipo de soporte. Para usar este recurso, la cuenta de servicio o clave API solicitante debe tener el rol de propietario del proyecto, administrador de gráficos del proyecto, propietario del procesamiento de flujos del proyecto o administrador de acceso a la base de datos del proyecto.
Este comando se autogenera y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/atlas/reference/api-resources-spec/v2/#tag/Database-Users/operation/createDatabaseUser.
Para obtener más información y ejemplos, consulte la documentación de la API referenciada en el enlace anterior.
Sintaxis
atlas api databaseUsers createDatabaseUser [options]
opciones
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
--sobre | envolvente | false | Indicador que indica si la aplicación envuelve la respuesta en un objeto JSON tipo sobre. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como sobre. La aplicación añade el parámetro de estado al cuerpo de la respuesta. |
--file | string | false | Ruta a tu archivo de solicitud de API. Déjalo en blanco para usar la entrada estándar; debes proporcionar una u otra, pero no ambas. |
--ID de grupo | string | true | Cadena única de dígitos hexadecimales 24que identifica su proyecto. Utilice el punto de conexión [/groups](#tag/Projects/operation/listProjects) para recuperar todos los proyectos a los que el usuario autenticado tiene acceso. NOTA: Grupos y proyectos son términos sinónimos. El ID de tu grupo es el mismo que el de tu proyecto. Para los grupos existentes, el ID de tu grupo/proyecto permanece igual. El recurso y los puntos finales correspondientes usan el término "grupos". |
-h, --ayuda | false | ayuda para createDatabaseUser | |
-o, --output | string | false | formato de API preferido, puede ser ["json", go-template] Este valor predeterminado es "json". |
--archivo de salida | string | false | archivo para guardar la salida de la api. Este flag es necesario cuando la salida de un endpoint es binaria (ej.: gzip) y el comando no se redirige (ej.: comando atlas > out.zip) |
--bonito | false | Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint. | |
--versión | string | false | Versión de API a utilizar al llamar a la llamada de API [opciones: "2023-01-01"], el valor predeterminado es la última versión o el valor de configuración api_version de los perfiles si está configurado. Este valor predeterminado es "2023-01-01". |
Opciones heredadas
Nombre | Tipo | Requerido | Descripción |
|---|---|---|---|
-P, --profile | string | false | Nombre del perfil que se usará en el archivo de configuración. Para obtener más información sobre los perfiles de la CLI de Atlas, consulte https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
Crea el archivo a continuación y guárdalo como payload.json
# AWS IAM Authentication { "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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
# AWS IAM Authentication atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
Crea el archivo a continuación y guárdalo como payload.json
# LDAP Authentication { "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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
# LDAP Authentication atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
Crea el archivo a continuación y guárdalo como payload.json
# OIDC Workforce Federated Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "oidcAuthType": "IDP_GROUP", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "5dd7496c7a3e5a648454341c/sales" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
# OIDC Workforce Federated Authentication atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
Crea el archivo a continuación y guárdalo como payload.json
# OIDC Workload Federated Authentication { "databaseName": "$external", "groupId": "32b6e34b3d91647abb20e7b8", "oidcAuthType": "USER", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "5dd7496c7a3e5a648454341c/sales" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
# OIDC Workload Federated Authentication atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
Crea el archivo a continuación y guárdalo como payload.json
# SCRAM-SHA Authentication { "databaseName": "admin", "groupId": "32b6e34b3d91647abb20e7b8", "password": "changeme123", "roles": [ { "databaseName": "sales", "roleName": "readWrite" }, { "databaseName": "marketing", "roleName": "read" } ], "scopes": [ { "name": "myCluster", "type": "CLUSTER" } ], "username": "david" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
# SCRAM-SHA Authentication atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8
Crea el archivo a continuación y guárdalo como payload.json
# X509 Authentication { "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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
# X509 Authentication atlas api databaseUsers createDatabaseUser --version 2023-01-01 --file payload.json --groupId 32b6e34b3d91647abb20e7b8