Delete a Custom Role

Info With Circle IconCreated with Sketch.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.

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 With Circle IconCreated with Sketch.Important

You cannot delete a custom 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 database users with no roles.
DELETE /api/atlas/v1.0/groups/{GROUP-ID}/customDBRoles/roles/{ROLE-NAME}
GROUP-IDRequired.The unique identifier for the project.
ROLE-NAMERequired.The name of the role to update.

The following query parameters are optional:

Query ParameterTypeDescriptionDefault
prettybooleanDisplays response in a prettyprint format.false
envelopebooleanSpecifies whether or not to wrap the response in an envelope.false

This endpoint does not use HTTP request body parameters.

This endpoint does not have response elements.

Important With Circle IconCreated with Sketch.Important

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

curl --user '{PUBLIC-KEY}:{PRIVATE-KEY}' --digest \
--header 'Accept: application/json' \
--include \
--request DELETE "{GROUP-ID}/customDBRoles/roles/ShardingAdmin?pretty=true"

This endpoint does not return a response body.

Give Feedback