Actualiza un usuario de la base de datos que pertenece al proyecto especificado.
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 ser admin.
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 | awsIAMType |
ROLE |
ARN |
| AWS IAM | awsIAMType |
USER |
ARN |
| X.509 | x509Type |
CUSTOMER |
RFC 2253 nombre distinguido |
| X.509 | x509Type |
MANAGED |
RFC 2253 nombre distinguido |
| LDAP | ldapAuthType |
USER |
RFC 2253 nombre distinguido |
| LDAP | ldapAuthType |
GROUP |
RFC 2253 nombre distinguido |
| Fuerza laboral o carga de trabajo del OIDC | oidcAuthType |
IDP_GROUP |
ID IDP ODIDC de Atlas (encontrado en la configuración de federación), seguido de un '/', seguido de un identificador de grupo del groupsClaimconfigurado del IdP. Úsase cuando la authorizationType del IdP es GROUP. La reclamación del grupo puede ser una reivindicación personalizada, como roles. |
| Fuerza laboral o carga de trabajo del OIDC | oidcAuthType |
USER |
ID IDP OIDC de Atlas (encontrado en la configuración de federación), seguido de un '/', seguido de un identificador de usuario del userClaimconfigurado del IDP. Úsase cuando el authorizationType del IdP está USER. |
| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType |
NONE |
Alphanumeric string |
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.
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, USER o ROLE. El valor por defecto es NONE.
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 ser admin.
Los valores son admin o $external. El valor por defecto es admin.
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 se encuentre dentro de la semana siguiente a la realización de la solicitud a la interfaz de programación de aplicaciones (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, GROUP o USER. El valor por defecto es NONE.
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_GROUP en este campo.
Los valores son NONE, IDP_GROUP o USER. El valor por defecto es NONE.
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.
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 | awsIAMType |
ROLE |
ARN |
| AWS IAM | awsIAMType |
USER |
ARN |
| X.509 | x509Type |
CUSTOMER |
RFC 2253 nombre distinguido |
| X.509 | x509Type |
MANAGED |
RFC 2253 nombre distinguido |
| LDAP | ldapAuthType |
USER |
RFC 2253 nombre distinguido |
| LDAP | ldapAuthType |
GROUP |
RFC 2253 nombre distinguido |
| Fuerza laboral o carga de trabajo del OIDC | oidcAuthType |
IDP_GROUP |
ID IDP ODIDC de Atlas (encontrado en la configuración de federación), seguido de un '/', seguido de un identificador de grupo del groupsClaimconfigurado del IdP. Úsase cuando la authorizationType del IdP es GROUP. La reclamación del grupo puede ser una reivindicación personalizada, como roles. |
| Fuerza laboral o carga de trabajo del OIDC | oidcAuthType |
USER |
ID IDP OIDC de Atlas (encontrado en la configuración de federación), seguido de un '/', seguido de un identificador de usuario del userClaimconfigurado del IDP. Úsase cuando el authorizationType del IdP está USER. |
| SCRAM-SHA | awsIAMType, x509Type, ldapAuthType, oidcAuthType |
NONE |
Alphanumeric string |
La longitud máxima es 1024.
Método X.509 que utiliza MongoDB Cloud para autenticar al usuario de base de datos.
MANAGED.CUSTOMER.Los usuarios creados con el método CUSTOMER requieren 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, CUSTOMER o MANAGED. El valor por defecto es NONE.
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"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint) No provider AWS exists.",
"error": 400,
"errorCode": "VALIDATION_ERROR",
"reason": "Bad Request"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 401,
"errorCode": "NOT_ORG_GROUP_CREATOR",
"reason": "Unauthorized"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 403,
"errorCode": "CANNOT_CHANGE_GROUP_NAME",
"reason": "Forbidden"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint) Cannot find resource AWS",
"error": 404,
"errorCode": "RESOURCE_NOT_FOUND",
"reason": "Not Found"
}
{
"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",
"error": 409,
"errorCode": "CANNOT_DELETE_ORG_ACTIVE_LIVE_MIGRATION_ATLAS_ORG_LINK",
"reason": "Conflict"
}
{
"detail": "(This is just an example, the exception may not be related to this endpoint)",
"error": 500,
"errorCode": "UNEXPECTED_ERROR",
"reason": "Internal Server Error"
}