Vista previa pública: proporcione comentarios: crea un usuario de base de datos en el proyecto especificado.
El subcomando de la API de Atlas, generado automáticamente a partir de la API de administración de MongoDB Atlas, ofrece cobertura total de la API de administración y actualmente se encuentra en Vista Previa Pública (por favor, proporciona comentarios en https://feedback.mongodb.com/forums/930808-atlas-cli). Las capacidades de la Admin API tienen su propio ciclo de vida de lanzamientos, que se puede consultar en el enlace de documentación del endpoint de API proporcionado.
Esta nube de MongoDB admite un máximo de 100 usuarios de base de datos por proyecto. Si necesitas más de 100 usuarios de base de datos en un proyecto, contacta con Soporte. Para utilizar este recurso, la Cuenta de servicio que realiza la solicitud o la clave API debe tener el rol de Propietario del Proyecto, de Administrador de Charts del Proyecto, de Propietario de Stream Processing del Proyecto o de Administrador de acceso a la base de datos del Proyecto.
Este comando se genera automáticamente y corresponde 1:1 con el endpoint de la API de Atlas https://www.mongodb.com/es/docs/api/doc/atlas-admin-api-v2/operation/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 |
|---|---|---|---|
--envelope | envelope | 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éjelo vacío para utilizar la entrada estándar en su lugar; debe proporcionar uno u otro, pero no ambos. |
--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 utilizará en tu archivo de configuración. Para aprender sobre los perfiles para el Atlas CLI, consulta https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Ejemplos
Autenticación de AWS IAM
Cree el archivo siguiente y guárdelo 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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
Autenticación LDAP
Cree el archivo siguiente y guárdelo 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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
Autenticación federada de la fuerza laboral de OIDC
Cree el archivo siguiente y guárdelo 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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
Autenticación federada de carga de trabajo de OIDC
Cree el archivo siguiente y guárdelo 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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
Autenticación SCRAM-SHA
Cree el archivo siguiente y guárdelo 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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8
Autenticación X509
Cree el archivo siguiente y guárdelo 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" }
Después de crear payload.json, ejecute el siguiente comando en el mismo directorio.
atlas api databaseUsers createDatabaseUser --version 2023-01-01 --groupId 32b6e34b3d91647abb20e7b8