Update Organization Roles for One User
On this page
Cloud Manager will no longer support Automation, Backup, and Monitoring for MongoDB 3.6 and 4.0 after August 30th, 2024. Please upgrade your MongoDB deployment or migrate to Atlas.
- OAuth 2.0 authentication for programmatic access to Cloud Manager is available as a Preview feature.
- The feature and the corresponding documentation might change at any time during the Preview period. To use OAuth 2.0 authentication, create a service account to use in your requests to the Cloud Manager Public API.
Updates the roles of one user in the specified organization. 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
Organization User Admin role.
Base URL: https://cloud.mongodb.com/api/public/v1.0
Resource
PUT /orgs/{ORG-ID}/users/{USER-ID}/roles
Request Parameters
Request Path Parameters
Name | Type | Description |
|---|---|---|
ORG-ID | string | (Required.) 24-hexadecimal digit string that identifies the
organization whose information you want
to retrieve. |
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:
| false |
Request Body Parameters
Name | Type | Description |
|---|---|---|
orgRoles | array | List of objects that describe the roles of the user. |
Response
Name | Type | Description |
|---|---|---|
orgRoles | 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/orgs/{ORG-ID}/users/{USER-ID}/roles" --data ' [ { "orgRoles: ["ORG_OWNER, "ORG_MEMBER", "ORG_BILLING_ADMIN"] } ]'
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} X-MongoDB-Service-Version: gitHash={gitHash}; versionString={ApplicationVersion}
Response Body
{ "orgRoles": [ "ORG_OWNER", "ORG_MEMBER", "ORG_BILLING_ADMIN" ] }