Delete a Custom MongoDB Role¶

On this page

Syntax
Example Request
- Request
- Response

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.

Important

You cannot delete a custom MongoDB role in the following scenarios:

When deleting the role would leave one or more child roles with no parent roles or actions.
When deleting the role would leave one or more MongoDB users with no roles.

Syntax¶

copy

DELETE /api/atlas/v1.0/groups/{GROUP-ID}/customDBRoles/roles/{ROLE-NAME}

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¶

This endpoint does not use HTTP request body parameters.

Response Elements¶

This endpoint does not have response elements.

Example Request¶

Request¶

Important

You must modify the following code block with the appropriate credentials and project ID.

copy

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
 --header 'Accept: application/json' \
 --include \
 --request DELETE "https://cloud.mongodb.com/api/atlas/v1.0/groups/{GROUP-ID}/customDBRoles/roles/ShardingAdmin?pretty=true"

Response¶

This endpoint does not return a response body.

← Update a Custom MongoDB Role Custom Role Actions →