Navigation
You were redirected from a different version of the documentation. Click here to go back.

Update Project Roles for One User

Updates the roles of one user in the specified project. To specify the user to update, provide the unique 24-hexadecimal digit string that identifies the user in the specified project. To use this resource, the requesting API Key must have the Project User Admin role.

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

Resource

PUT /groups/{PROJECT-ID}/users/{USER-ID}/roles

Request Parameters

Request Path Parameters

Name Type Description
PROJECT-ID string (Required.) Unique 24-hexadecimal digit string that identifies project.
USER-ID string (Required.) Unique 24-hexadecimal digit string that identifies the user to modify.

Request Query Parameters

The following query parameters 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 that 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:

Name Description
status HTTP response code
envelope Expected response body
false

Request Body Parameters

Name Type Description
groupRoles array List of objects that describe the roles of the user.

Response

Name Type Description
groupRoles array List of objects that describe the roles of the user.

Example Request

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --include \
     --request PUT "https://cloud.mongodb.com/api/public/v1.0/groups/{PROJECT-ID}/users/{USER-ID}/roles"
     --data '
     [
      {
        "groupRoles: ["GROUP_OWNER, "GROUP_USER_ADMIN", "GROUP_READ_ONLY"]
      }
     ]'

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}
X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}

Response Body

{
   "groupRoles": [
     "GROUP_OWNER",
     "GROUP_USER_ADMIN",
     "GROUP_READ_ONLY"
   ]
}