MongoDBMongoDB Atlas Administration API v2
PATCH/api/atlas/v2/groups/{groupId}/databaseUsers/{databaseName}/{username}
Manage update Group Database User.
Contract-preserving PATCH endpoint for update Group Database User in the MongoDB Atlas Administration API. Resource-specific values are supplied by the caller at runtime.
All 540 MongoDB Atlas administration endpoints from a fixed Apache-2.0 OpenAPI revision. Hub provides documentation and an independent SDK/CLI, but never proxies account, organization, project, network, backup, or operational data; callers connect directly with local credentials.
Request
- operationId
updateGroupDatabaseUser- Server
https://cloud.mongodb.com- Authentication
- ServiceAccounts, DigestAuth
Request parameters
envelope
queryboolean
envelope value in the Atlas Administration API contract.
groupId
pathstringrequired
group Id value in the Atlas Administration API contract.
32b6e34b3d91647abb20e7b8
pretty
queryboolean
pretty value in the Atlas Administration API contract.
databaseName
pathstringrequired
database Name value in the Atlas Administration API contract.
username
pathstringrequired
username value in the Atlas Administration API contract.
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
Request body
CloudDatabaseUserrequired
Content-Type: application/vnd.atlas.2023-01-01+json
Properties: awsIAMTypedatabaseNamedeleteAfterDatedescriptiongroupIdlabelsldapAuthTypelinksoidcAuthTypepasswordrolesscopesusernamex509Type
Responses
200
CloudDatabaseUserapplication/vnd.atlas.2023-01-01+json
Successful supplier response.
Properties: awsIAMTypedatabaseNamedeleteAfterDatedescriptiongroupIdlabelsldapAuthTypelinksoidcAuthTypepasswordrolesscopesusernamex509Type
400
ApiErrorapplication/json
Supplier response with HTTP status 400.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
401
ApiErrorapplication/json
Supplier response with HTTP status 401.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
403
ApiErrorapplication/json
Supplier response with HTTP status 403.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
404
ApiErrorapplication/json
Supplier response with HTTP status 404.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
409
ApiErrorapplication/json
Supplier response with HTTP status 409.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
429
ApiErrorapplication/json
Supplier response with HTTP status 429.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
500
ApiErrorapplication/json
Supplier response with HTTP status 500.
Properties: badRequestDetaildetailerrorerrorCodeparametersreason
{
"awsIAMType": "NONE",
"databaseName": "admin",
"labels": {},
"ldapAuthType": "NONE",
"links": {
"href": "https://cloud.mongodb.com/api/atlas",
"rel": "self"
}
}