- API >
- API Resources >
- Custom MongoDB Roles >
- Update a Custom MongoDB Role
Update a Custom MongoDB Role¶
On this page
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. The resource and corresponding endpoints use the
term groups
.
Base URL: https://cloud.mongodb.com/api/atlas/v1.0
The Atlas API uses HTTP Digest Authentication. Provide your Atlas username as the username and Atlas 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 Configure Atlas API Access.
Syntax¶
Request Path Parameters¶
Parameter | Required/Optional | Description |
---|---|---|
GROUP-ID |
Required. | The unique identifier for the project. |
ROLE-NAME |
Required. | The name of the role to update. |
Request Query Parameters¶
The following query parameters are optional:
Query Parameter | Type | Description | Default |
---|---|---|---|
pretty |
boolean | Displays response in a prettyprint format. | false |
envelope |
boolean | Specifies whether or not to wrap the response in an envelope. | false |
Request Body Parameters¶
Important
Only the properties specified in the request body are updated.
For example, if you do not specify the actions
array, the
custom role retains the actions
it had before the request
was made.
You cannot update a role’s roleName
. To rename a role, you
must delete it and recreate the role with the desired the name.
Name | Type | Description |
---|---|---|
actions |
array | Each object in the actions array represents an individual
privilege action
granted by the role. |
actions.action |
string | Name of the privilege action. For a complete list of actions available in the Atlas API, see Custom Role Actions. |
actions.resources |
array | Contains information on where the action is granted. Each object in the array either indicates a database and collection on which the action is granted, or indicates that the action is granted on the cluster resource. |
actions.resources.collection |
string | Collection on which the action is granted. If this value is an
empty string, the action is granted on all collections within
the database specified in the Note This field is mutually exclusive with the
|
actions.resources.db |
string | Database on which the action is granted. Note This field is mutually exclusive with the
|
actions.resources.cluster |
boolean | Set to Note This field is mutually exclusive with the
|
inheritedRoles |
array | Each object in the inheritedRoles array represents a
key-value pair indicating the inherited role and the
database on which the role is granted. |
inheritedRoles.db |
string | Database on which the inherited role is granted. |
inheritedRoles.role |
string | Name of the inherited role. This can either be another custom role or a built-in role. |
Response Elements¶
This endpoint does not have response elements.