Navigation

Update a User

Note

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. This page uses the more familiar term group when referring to descriptions. The endpoint remains as stated in the document.

Update an existing user. Unspecified fields preserve their current values.

Note

You cannot update the password field for security reasons.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Resource

PATCH /users/{USER-ID}

Request Path Parameters

Name Type Necessity Description
USER-ID string Required Unique identifier of the user that you want to retrieve. To retrieve the USER-ID for a user, see Get All Users in One Project.

Request Query Parameters

The following query parameters are optional:

Name Type Description Default
pretty boolean Indicates whether the response body should be in a prettyprint format. false
envelope boolean

Indicates whether or not to wrap the response in an envelope.

Some API 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:

status
HTTP response code
envelope
The expected response body
false

Request Body Parameters

Name Type Description
id string Unique identifier of the Cloud Manager user.
username string Username of the Cloud Manager user.
emailAddress string Email address of the Cloud Manager user.
mobileNumber string Mobile telephone number of the Cloud Manager user.
firstName string First name of the Cloud Manager user.
lastName string Last name of the Cloud Manager user.
roles object array Role assignments of the Cloud Manager user.
roles.orgId string Unique identifier of the organization in which the Cloud Manager user has the specified role.
roles.groupId string Unique identifier of the group in which the Cloud Manager user has the specified role.
roles.roleName string

Name of the role. Accepted values are:

Value Description
ORG_MEMBER Organization Member
ORG_READ_ONLY Organization Read Only
ORG_BILLING_ADMIN Organization Billing Admin
ORG_GROUP_CREATOR Organization Project Creator
ORG_OWNER Organization Owner
GROUP_ATLAS_ADMIN Project Admin (Atlas)
GROUP_AUTOMATION_ADMIN Project Automation Admin
GROUP_BACKUP_ADMIN Project Backup Admin
GROUP_MONITORING_ADMIN Project Monitoring Admin
GROUP_OWNER Project Owner
GROUP_READ_ONLY Project Read Only
GROUP_USER_ADMIN Project User Admin
GROUP_BILLING_ADMIN Project Billing Admin
GROUP_DATA_ACCESS_ADMIN Project Data Access Admin
GROUP_DATA_ACCESS_READ_ONLY Project Data Access Read Only
GROUP_DATA_ACCESS_READ_WRITE Project Data Access Read/Write

Response

Name Type Description
emailAddress string Email address of the Cloud Manager user.
firstName string First name of the Cloud Manager user.
id string Unique identifier of the Cloud Manager user.
lastName string Last name of the Cloud Manager user.
links object array Links to related sub-resources. All links arrays in responses include at least one link called self. The relationship between URLs are explained in the Web Linking Specification.
mobileNumber string Mobile number of the Cloud Manager user.
roles object array Role assignments.
roles.groupId string Unique identifier for the project in which the user has the specified role.
roles.orgId string Unique identifier for the organization in which the user has the specified role.
roles.roleName string

Name of the role. Values are:

Note

The users resource returns all the roles the user has in both Cloud Manager and MongoDB Atlas.

Value Description
ORG_MEMBER Organization Member
ORG_READ_ONLY Organization Read Only
ORG_BILLING_ADMIN Organization Billing Admin
ORG_GROUP_CREATOR Organization Project Creator
ORG_OWNER Organization Owner
GROUP_ATLAS_ADMIN Project Admin (Atlas)
GROUP_AUTOMATION_ADMIN Project Automation Admin
GROUP_BACKUP_ADMIN Project Backup Admin
GROUP_MONITORING_ADMIN Project Monitoring Admin
GROUP_OWNER Project Owner
GROUP_READ_ONLY Project Read Only
GROUP_USER_ADMIN Project User Admin
GROUP_BILLING_ADMIN Project Billing Admin
GROUP_DATA_ACCESS_ADMIN Project Data Access Admin
GROUP_DATA_ACCESS_READ_ONLY Project Data Access Read Only
GROUP_DATA_ACCESS_READ_WRITE Project Data Access Read/Write
username string Username of the Cloud Manager user.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
  --header "Accept: application/json" \
  --header "Content-Type: application/json" \
  --include \
  --request PATCH "https://cloud.mongodb.com/api/public/v1.0/users/533dc19ce4b00835ff81e2eb" \
  --data '
    {
      "emailAddress": "jane@qa.example.com",
      "lastName": "D'oh"
    }'

Example Response

Response Header

HTTP/1.1 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
HTTP/1.1 200 OK
Vary: Accept-Encoding
Content-Type: application/json
Strict-Transport-Security: max-age=300
Date: {dateInUnixFormat}
Connection: keep-alive
Content-Length: {requestLengthInBytes}

Response Body

{
  "id" : "533dc19ce4b00835ff81e2eb",
  "username" : "jane",
  "emailAddress" : "jane@qa.example.com",
  "firstName" : "Jane",
  "lastName" : "D'oh",
  "roles" : [ {
    "groupId" : "533daa30879bb2da07807696",
    "roleName" : "GROUP_USER_ADMIN"
  },{
    "orgId" : "55555bbe3bd5253aea2d9b16",
    "roleName" : "ORG_MEMBER"
  } ],
  "links" : []
}