Update a Database User¶
On this page
Groups and projects are synonymous terms. Your {GROUP-ID}
is the
same as your project ID. For existing groups, your group/project ID
remains the same. The resource and corresponding endpoints use the
term groups
.
The Atlas Administration API uses HTTP Digest Authentication. Provide your Atlas username as the username and Atlas Administration API key as the password as part of the HTTP request.
This endpoint requires that the Atlas user has the Owner
role. To view the available Atlas users, click on
Users & Teams in the left-hand navigation.
For complete documentation on configuring API access for an Atlas project, see Get Started with the Atlas Administration API.
The parameters that this resource requires depend upon the authentication mechanism the database uses. Select from one of the following authentication mechanisms:
Send only those parameters that you want to change.
Resource¶
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
PATCH /groups/{GROUP-ID}/databaseUsers/{databaseName}/{USERNAME}
Behavior¶
- For permanent database users, you can change their roles and password. You can't change their name, their authentication database, or their user status to temporary.
- For temporary database users, you can change their expiration date, their user status to permanent, or both.
Request Path Parameters¶
Parameter | Type | Necessity | Description |
---|---|---|---|
GROUP-ID | string | Required | Unique 24-hexadecimal string that identifies the
project. |
DATABASE-NAME | string | Required | Database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. You may set this parameter value as: If you don't set an authentication mechanism, Atlas defaults to SCRAM-SHA. |
USERNAME | string | Required | Username that this resource updates in the MongoDB database. This username should be formatted as: |
Request Query Parameters¶
This endpoint might use any of the HTTP request query parameters available to all Atlas Administration API resources. All of these are optional.
Name | Type | Necessity | Description | Default | ||||||
---|---|---|---|---|---|---|---|---|---|---|
pretty | boolean | Optional | Flag indicating whether the response body should be in a
prettyprint format. | false | ||||||
envelope | boolean | Optional | Flag indicating if Atlas should wrap the response in a JSON envelope. This option may be needed for some API clients. These clients cannot access the HTTP response headers or status code. To remediate this, set envelope=true in the query. For endpoints that return one result, the response body includes:
| false |
Request Body Parameters¶
Name | Type | Necessity | Description | ||||||
---|---|---|---|---|---|---|---|---|---|
deleteAfterDate | string | Optional | ISO-8601-formatted UTC date after
which Atlas deletes the user. The specified date must be in
the future and within one week of the time you make the API
request. To update a temporary user to be permanent, set the
value of this field to Note You may include an ISO-8601 time zone designator to ensure that the expiration date occurs with respect to the local time in the specified time zone. Important You can only modify the expiration date for a user if an
expiration date was specified when creating the user. You
cannot assign a | ||||||
labels | array | Optional | List that contains key-value pairs that tag and categorize the database user. Each key and value has a maximum length of 255 characters.
| ||||||
roles | array | Required | Array of this user's roles and the databases / collections on
which the roles apply. A role allows the user to perform
particular actions on the specified database. A role on the
Note The available privilege actions for custom roles support a
subset of MongoDB commands. See
Unsupported Commands in Important If a user is assigned a custom role, they cannot be assigned any other roles. | ||||||
roles.databaseName | string | Optional | Database on which the user has the specified role. A role on the
admin database can include privileges that apply to the
other databases. | ||||||
roles.collectionName | string | Optional | Collection for which the role applies. You can specify a collection for the Note When applied to a collection, the In Atlas, In Atlas, | ||||||
roles.roleName | string | Required | Label given to a group of privileges assigned to a database user. This value can either be a built-in role or a custom role. The admin database accepts these values for the role parameter: Atlas limits this role to MongoDB databases that it manages. The role allows the user to enable sharding on a database and to shard a collection. Specific databases accept these values for the role parameter:
Specific collections accept these values for the role parameter:
If you don't specify a collection for the Note You can only set a custom role when
you set | ||||||
scopes | array | Optional | List of clusters and Atlas Data Lakes that this user can access. Returns an empty array if the database user has access to all the clusters and Atlas Data Lakes in the project. Atlas grants database users access to all resources by default.
| ||||||
scopes.name | string | Required | Name of the cluster or Atlas Data Lake that this user can access. | ||||||
scopes.type | string | Required | Type of resource that this user has access to. Valid values are:
| ||||||
password | string | Required | Alphanumeric string that authenticates the database user
against the database specified in databaseName. |
Response Elements¶
If you set the query element "envelope" : true
, this resource wraps
the response in a content
object.
Response Element | Type | Description |
---|---|---|
databaseName | string | Database against which the database user authenticates. Database users must provide both a username and authentication database to log into MongoDB. This resource returns: If you don't set an authentication mechanism, Atlas defaults to SCRAM-SHA. |
deleteAfterDate | string | Timestamp in ISO 8601 date and time format in UTC after which Atlas deletes the database user.
This resource returns this parameter if you set an expiration
date when creating the entry. |
groupId | string | Unique 24-hexadecimal string that identifies the
project to which the database user belongs. |
labels | array | List that contains key-value pairs that tag and categorize the
database user. |
links | array | One or more links to sub-resources and/or related resources. The relations between URLs are explained in the Web Linking Specification |
roles | array | Array of this user's roles and the databases / collections on
which the roles apply. A role allows the user to perform
particular actions on the specified database. A role on the
|
roles.collectionName | string | Collection on which the database user has the specified role. |
roles.databaseName | string | Database on which the database user has the specified role. A
role on the admin database can include privileges that apply
to the other databases. |
roles.roleName | string | Label given to a group of privileges assigned to a database user. This value can either be a built-in role or a custom role. The admin database accepts these values for the role parameter: Atlas limits this role to MongoDB databases that it manages. The role allows the user to enable sharding on a database and to shard a collection. Specific databases accept these values for the role parameter:
Specific collections accept these values for the role parameter:
If you don't specify a collection for the Note You can only set a custom role when
you set |
scopes | array | List of clusters and Atlas Data Lakes that this user can access.
Returns an empty array if the database user has access to all
the clusters and Atlas Data Lakes in the project. Atlas
grants database users access to all resources by default. |
scopes.name | string | Name of the cluster or Atlas Data Lake that the database user can
access. |
scopes.type | string | Type of resource that the database user can access. This parameter returns one of the following values:
|
username | string | Username needed to authenticate to the MongoDB database or collection. This resource returns: |
Example Request¶
Example Response¶
Response Header¶
401 Unauthorized Content-Type: application/json;charset=ISO-8859-1 Date: {dateInUnixFormat} WWW-Authenticate: Digest realm="MMS Public API", domain="", nonce="{nonce}", algorithm=MD5, op="auth", stale=false Content-Length: {requestLengthInBytes} Connection: keep-alive
200 OK Vary: Accept-Encoding Content-Type: application/json Strict-Transport-Security: max-age=300 Date: {dateInUnixFormat} Connection: keep-alive Content-Length: {requestLengthInBytes}