Actualiza un usuario de base de datos que pertenece al proyecto especificado. 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.
Parámetros de ruta
-
Cadena 24hexadecimal única que identifica su proyecto. Utilice el punto de conexión /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 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".
El formato debe coincidir con el siguiente patrón:
^([a-f0-9]{24})$. -
La base de datos en la que se autentica el usuario. Los usuarios de la base de datos deben proporcionar un nombre de usuario y una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP u OIDC Workload, este valor debe ser
$external. Si se autentica con SCRAM-SHA u OIDC Workforce, este valor debe seradmin. -
Etiqueta legible 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 Fuerza laboral de 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 IdP de Atlas OIDC (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre de usuario del IdP ¡FUERA! awsIAMType,x509Type,ldapAuthType,oidcAuthTypeNONECadena alfanumérica
Parámetros de consulta
-
Indicador que indica si la aplicación encapsula 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 solucionar esto, configure envelope=true en la consulta. Los endpoints que devuelven una lista de resultados utilizan el objeto de resultados como encapsulado. La aplicación añade el parámetro de estado al cuerpo de la respuesta.El valor predeterminado es
false. -
Bandera que indica si el cuerpo de la respuesta debe estar en formato prettyprint.
El valor predeterminado 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 administración de identidad y acceso (IAM) de Amazon Web Services (AWS) asociadas con el usuario o el rol del usuario.
Los valores son
NONE,USERoROLE. El valor predeterminado esNONE. -
La base de datos en la que se autentica el usuario. Los usuarios de la base de datos deben proporcionar un nombre de usuario y una base de datos de autenticación para iniciar sesión en MongoDB. Si el usuario se autentica con AWS IAM, x.509, LDAP u OIDC Workload, este valor debe ser
$external. Si se autentica con SCRAM-SHA u OIDC Workforce, este valor debe seradmin.Los valores son
admino$external. El valor predeterminado 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. -
Cadena de dígitos hexadecimales 24única que identifica el proyecto.
-
Lista que contiene los pares clave-valor para etiquetar y categorizar el usuario de la base de datos MongoDB. Las etiquetas que defina no aparecen en la consola.
Etiquetas legibles por humanos aplicadas a este componente de MongoDB Cloud.
-
Parte del registro del Protocolo ligero de acceso a directorios (LDAP) que la base de datos utiliza para autenticar a este usuario de base de datos en el host LDAP.
Los valores son
NONE,GROUPoUSER. El valor predeterminado esNONE. -
Etiqueta legible que indica si el nuevo usuario o grupo de la base de datos se autentica con la autenticación federada de OIDC. Para crear un usuario con autenticación federada, especifique el valor "USER" en este campo. Para crear un grupo con autenticación federada, especifique el valor "
IDP_GROUP" en este campo.Los valores son
NONE,IDP_GROUPoUSER. El valor predeterminado esNONE. -
Cadena alfanumérica que autentica a este usuario de la base de datos con la base de datos especificada en
databaseName. Para autenticarse con SCRAM-SHA, debe 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.
Gama de recursos disponibles para este usuario de base de datos.
-
Lista que contiene los clústeres, lagos de datos de MongoDB Atlas y espacios de trabajo de MongoDB Atlas Streams a los que este usuario de la base de datos puede acceder. Si se omite, MongoDB Cloud otorga al usuario de la base de datos acceso a todos los clústeres, lagos de datos de MongoDB Atlas y espacios de trabajo de MongoDB Atlas Streams del proyecto.
Gama de recursos disponibles para este usuario de base de datos.
-
Etiqueta legible 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 Fuerza laboral de 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 IdP de Atlas OIDC (que se encuentra en la configuración de la federación), seguido de un '/', seguido del nombre de usuario del IdP ¡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, especifique
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
atlas api databaseUsers updateDatabaseUser --helpimport (
"os"
"context"
"log"
sdk "go.mongodb.org/atlas-sdk/v20230101001/admin"
)
func main() {
ctx := context.Background()
clientID := os.Getenv("MONGODB_ATLAS_CLIENT_ID")
clientSecret := os.Getenv("MONGODB_ATLAS_CLIENT_SECRET")
// See https://dochub.mongodb.org/core/atlas-go-sdk-oauth
client, err := sdk.NewClient(sdk.UseOAuthAuth(clientID, clientSecret))
if err != nil {
log.Fatalf("Error: %v", err)
}
params = &sdk.UpdateGroupDatabaseUserApiParams{}
sdkResp, httpResp, err := client.DatabaseUsersApi.
UpdateGroupDatabaseUserWithParams(ctx, params).
Execute()
}
curl --include --header "Authorization: Bearer ${ACCESS_TOKEN}" \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \
-d '{ <Payload> }'curl --user "${PUBLIC_KEY}:${PRIVATE_KEY}" \
--digest --include \
--header "Accept: application/vnd.atlas.2023-01-01+json" \
--header "Content-Type: application/json" \
-X PATCH "https://cloud.mongodb.com/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}" \
-d '{ <Payload> }'{
"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"
}