Actualiza un usuario de base de datos que pertenece al proyecto especificado. Para utilizar este recurso, la cuenta de servicio solicitante o la clave API debe tener el rol de Propietario de Proyecto, Administrador de Charts de Proyecto, Propietario de Stream Processing de Proyecto o el rol de Administrador de Acceso a base de datos de Proyecto.
Parámetros de path
-
string única de 24dígitos hexadecimales que identifica tu proyecto. Usa el endpoint /groups 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 id de tu proyecto. Para los grupos ya existentes, el id de su grupo/proyecto sigue siendo el mismo. El recurso y los endpoints correspondientes utilizan el término grupos.
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
La base de datos contra la que se autentica el usuario de la base de datos. Los usuarios de la base de datos deben proporcionar tanto un nombre de usuario como una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP o OIDC carga de trabajo, este valor debe ser
$external. Si el usuario se autentica con SCRAM-SHA u OIDC Workforce, este valor debe seradmin. -
etiqueta legible por humanos que representa al usuario que se autentica en MongoDB. El formato de esta etiqueta depende del método de autenticación:
Método de autenticación Parámetro necesario Valor del parámetro Formato de nombre de usuario AWS IAM awsIAMTypeROLEARN AWS IAM awsIAMTypeUSERARN X.509 x509TypeCUSTOMERRFC 2253 nombre distinguido X.509 x509TypeMANAGEDRFC 2253 nombre distinguido LDAP ldapAuthTypeUSERRFC 2253 nombre distinguido LDAP ldapAuthTypeGROUPRFC 2253 nombre distinguido Plantilla de trabajo OIDC oidcAuthTypeIDP_GROUPID de IdP de Atlas OIDC (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre del grupo de IdP OIDC carga de trabajo oidcAuthTypeUSERID de proveedor de identidad de Atlas OIDC (encontrado en la configuración de federación), seguido de un '/', seguido del nombre de usuario de proveedor de identidad ¡FUERA! awsIAMType,x509Type,ldapAuthType,oidcAuthTypeNONECadena alfanumérica
Parámetros de query
-
Bandera que indica si la aplicación envuelve la respuesta en un objeto JSON
envelope. Algunos clientes de la API no pueden acceder a los encabezados de respuesta HTTP ni al código de estado. Para remediar esto, establece envelope=true en la query. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como un sobre. La aplicación agrega el parámetro de estado al cuerpo de la respuesta.El valor por defecto es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en el formato prettyprint.
El valor por defecto es
false.Impresión bonita
Cuerpo
Requerido
Actualiza un usuario de la base de datos que pertenece al proyecto especificado.
-
Etiqueta legible por humanos que indica si el nuevo usuario de la base de datos se autentica con las credenciales de Amazon Web Services (AWS) de Identity and Access Gestión (IAM) asociadas al usuario o al rol del usuario.
Los valores son
NONE,USERoROLE. El valor predeterminado esNONE. -
La base de datos contra la que se autentica el usuario de la base de datos. Los usuarios de la base de datos deben proporcionar tanto un nombre de usuario como una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP o OIDC carga de trabajo, este valor debe ser
$external. Si el usuario se autentica con SCRAM-SHA u OIDC Workforce, este valor debe seradmin.Los valores son
admino$external. El valor por defecto esadmin. -
Fecha y hora en que MongoDB Cloud elimina al usuario. Este parámetro expresa su valor en el formato de marca de tiempo ISO 8601 en UTC y puede incluir la designación de la zona horaria. Debe especificar una fecha futura que caiga dentro de una semana después de realizar la solicitud de la API.
-
Descripción de este usuario de base de datos.
La longitud máxima es
100. -
string única de 24 dígitos hexadecimales que identifica el Proyecto.
-
Lista que contiene los pares clave-valor para etiquetar y categorizar al usuario de base de datos de MongoDB. Las etiquetas que definas no aparecerán en la consola.
-
Parte del registro del Protocolo Ligero de Acceso a Directorios (LDAP) que la base de datos utiliza para autenticar a este usuario de la base de datos en el host LDAP.
Los valores son
NONE,GROUPoUSER. El valor predeterminado esNONE. -
etiqueta legible por humanos que indica si el nuevo usuario de base de datos o grupo se autentica con autenticación federada OIDC. Para crear un usuario con autenticación federada, especifica el valor de USUARIO en este campo. Para crear un grupo de autenticación federada, especifica el valor de
IDP_GROUPen este campo.Los valores son
NONE,IDP_GROUPoUSER. El valor predeterminado esNONE. -
string alfanumérico que autentica a este usuario de base de datos en la base de datos especificada en
databaseName. Para autenticarse con SCRAM-SHA, debes especificar este parámetro. Este parámetro no aparece en esta respuesta.La longitud mínima es
8.¡FUERA! -
Lista que proporciona los emparejamientos de un rol con una base de datos aplicable.
-
Lista que contiene clústeres, MongoDB Atlas Data Lakes y MongoDB Atlas Streams Workspaces a los que este usuario de base de datos puede acceder. Si se omite, MongoDB Cloud concederá al usuario de base de datos acceso a todos los clústeres, MongoDB Atlas Data Lakes y MongoDB Atlas Streams Workspaces en el Proyecto.
-
etiqueta legible por humanos que representa al usuario que se autentica en MongoDB. El formato de esta etiqueta depende del método de autenticación:
Método de autenticación Parámetro necesario Valor del parámetro Formato de nombre de usuario AWS IAM awsIAMTypeROLEARN AWS IAM awsIAMTypeUSERARN X.509 x509TypeCUSTOMERRFC 2253 nombre distinguido X.509 x509TypeMANAGEDRFC 2253 nombre distinguido LDAP ldapAuthTypeUSERRFC 2253 nombre distinguido LDAP ldapAuthTypeGROUPRFC 2253 nombre distinguido Plantilla de trabajo OIDC oidcAuthTypeIDP_GROUPID de IdP de Atlas OIDC (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre del grupo de IdP OIDC carga de trabajo oidcAuthTypeUSERID de proveedor de identidad de Atlas OIDC (encontrado en la configuración de federación), seguido de un '/', seguido del nombre de usuario de proveedor de identidad ¡FUERA! awsIAMType,x509Type,ldapAuthType,oidcAuthTypeNONECadena alfanumérica La longitud máxima es
1024. -
Método X.509 que MongoDB Cloud utiliza para autenticar al usuario de la base de datos.
- Para X.509 gestionado por la aplicación, especifica
MANAGED. - Para X.509 autogestionado, especifica
CUSTOMER.
Los usuarios creados con el método
CUSTOMERrequieren un Common Name (CN) en el parámetro nombre de usuario. Debes crear usuarios autenticados externamente en la base de datos$external.Los valores son
NONE,CUSTOMERoMANAGED. El valor predeterminado esNONE. - Para X.509 gestionado por la aplicación, especifica
curl \
--request PATCH 'https://cloud.mongodb.com/api/atlas/v1.0/groups/32b6e34b3d91647abb20e7b8/databaseUsers/{databaseName}/SCRAM-SHA: dylan or AWS IAM: arn:aws:iam::123456789012:user/sales/enterprise/DylanBloggs or x.509/LDAP: CN=Dylan Bloggs,OU=Enterprise,OU=Sales,DC=Example,DC=COM or OIDC: IdPIdentifier/IdPGroupName' \
--header "Authorization: Bearer $ACCESS_TOKEN" \
--header "Content-Type: application/json" \
--data '{"awsIAMType":"NONE","databaseName":"admin","deleteAfterDate":"2026-05-04T09:42:00Z","description":"string","groupId":"string","labels":[{"key":"string","value":"string"}],"ldapAuthType":"NONE","oidcAuthType":"NONE","password":"string","roles":[{"collectionName":"string","databaseName":"string","roleName":"atlasAdmin"}],"scopes":[{"name":"string","type":"CLUSTER"}],"username":"string","x509Type":"NONE"}'{
"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2026-05-04T09:42:00Z",
"description": "string",
"groupId": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"oidcAuthType": "NONE",
"password": "string",
"roles": [
{
"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [
{
"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}{
"awsIAMType": "NONE",
"databaseName": "admin",
"deleteAfterDate": "2026-05-04T09:42:00Z",
"description": "string",
"labels": [
{
"key": "string",
"value": "string"
}
],
"ldapAuthType": "NONE",
"links": [
{
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
],
"oidcAuthType": "NONE",
"roles": [
{
"collectionName": "string",
"databaseName": "string",
"roleName": "atlasAdmin"
}
],
"scopes": [
{
"name": "string",
"type": "CLUSTER"
}
],
"username": "string",
"x509Type": "NONE"
}{
"error": 400,
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"reason": "Bad Request",
"errorCode": "VALIDATION_ERROR"
}{
"error": 401,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Unauthorized",
"errorCode": "NOT_ORG_GROUP_CREATOR"
}{
"error": 403,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Forbidden",
"errorCode": "CANNOT_CHANGE_GROUP_NAME"
}{
"error": 404,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"reason": "Not Found",
"errorCode": "RESOURCE_NOT_FOUND"
}{
"error": 409,
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot delete organization link while there is active migration in following project ids: 60c4fd418ebe251047c50554",
"reason": "Conflict",
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK"
}{
"error": 500,
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"reason": "Internal Server Error",
"errorCode": "UNEXPECTED_ERROR"
}