How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

MongoDB Custom Database Roles API

Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. You define custom roles at the project level, for all clusters in the project. This resource supports a subset of MongoDB privilege actions. You can create a subset of custom role actions. To create a wider list of custom role actions, use the MongoDB Cloud user interface. Custom roles must include actions that all project's clusters support, and that are compatible with each MongoDB version that your project's clusters use. For example, if your project has MongoDB 4.2 clusters, you can't create custom roles that use actions introduced in MongoDB 4.4.

MongoDB Custom Database Roles API is one of 53 APIs that MongoDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Custom Database Roles. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, rate-limit docs, and a changelog.

This API exposes 5 operations across 2 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version 2.0.

Requests are made against a single base URL, https://cloud.mongodb.com.

5 operations 2 paths 8 schemas 1 DELETE2 GET1 PATCH1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0
Base URL
https://cloud.mongodb.com/api/atlas/v2
Authentication
HTTP Digest, OAuth 2.0
Terms of Service
Resource Areas
1

Authentication & Security 2

MongoDB Custom Database Roles API declares 2 security schemes for authenticating requests. It uses HTTP digest authentication (DigestAuth). It supports OAuth 2.0 (ServiceAccounts) using the clientCredentials flow. By default, every request must be authenticated.

  • ServiceAccounts — Learn more about [Service Accounts](https://www.mongodb.com/docs/atlas/api/service-accounts-overview).

Paths & Operations 5

Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Custom Database Roles 5

Returns, adds, edits, and removes custom database user privilege roles. Use custom roles to specify custom sets of actions that the MongoDB Cloud built-in roles can't describe. Yo…

GET
/api/atlas/v2/groups/{groupId}/customDBRoles/roles
Return All Custom Roles in One Project
listGroupCustomDbRoleRoles 3 params → 200401403404429500
POST
/api/atlas/v2/groups/{groupId}/customDBRoles/roles
Create One Custom Role
createGroupCustomDbRoleRole 3 params body → 202400401403404409429500
DELETE
/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}
Remove One Custom Role from One Project
deleteGroupCustomDbRoleRole 4 params → 204400401403404409429500
GET
/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}
Return One Custom Role in One Project
getGroupCustomDbRoleRole 4 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/customDBRoles/roles/{roleName}
Update One Custom Role in One Project
updateGroupCustomDbRoleRole 4 params body → 200400401403404409429500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are ApiError (6 properties), DatabasePermittedNamespaceResource (3 properties), UserCustomDBRole (3 properties), DatabaseInheritedRole (2 properties). Each schema is shown below with its type and property counts.

DatabasePrivilegeAction
object
Privilege action that the role grants.
2 properties 2 required
ApiError
object
6 properties 2 required
FieldViolation
object
2 properties 2 required
UserCustomDBRole
object
3 properties 1 required
DatabasePermittedNamespaceResource
object
Namespace to which this database user has access.
3 properties 3 required
UpdateCustomDBRole
object
2 properties
BadRequestDetail
object
Bad request detail.
1 property
DatabaseInheritedRole
object
Role inherited from another context for this database user.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-custom-database-roles-api-openapi.yml Raw ↑

Other APIs MongoDB publishes across the network.

MongoDB Atlas Data API
MongoDB Atlas App Services Admin API
MongoDB Access Tracking API
MongoDB Activity Feed API
MongoDB Alert Configurations API
MongoDB Alerts API
MongoDB Atlas Search API
MongoDB Auditing API
MongoDB AWS Clusters DNS API
MongoDB Cloud Backups API
MongoDB Cloud Migration Service API
MongoDB Cloud Provider Access API
Where this information came from

This is an independent, third-party profile of MongoDB Custom Database Roles API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.