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 LDAP Configuration API

Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication and authorization. Your LDAP server must be visible to the internet or connected to your MongoDB Cloud cluster with VPC Peering. Also, your LDAP server must use TLS. You must have the MongoDB Cloud admin user privilege to use these endpoints. Also, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or higher. Groups for which you have configured LDAPS can't create a cluster using a version of MongoDB 3.6 or lower.

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

Tagged areas include LDAP Configuration. 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 4 paths, and defines 11 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 4 paths 11 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 LDAP Configuration 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 4 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.

LDAP Configuration 5

Returns, edits, verifies, and removes LDAP configurations. An LDAP configuration defines settings for MongoDB Cloud to connect to your LDAP server over TLS for user authentication…

GET
/api/atlas/v2/groups/{groupId}/userSecurity
Return LDAP or X.509 Configuration
getGroupUserSecurity 3 params → 200401403404429500
PATCH
/api/atlas/v2/groups/{groupId}/userSecurity
Update LDAP or X.509 Configuration
updateGroupUserSecurity 3 params body → 202400401403404429500
DELETE
/api/atlas/v2/groups/{groupId}/userSecurity/ldap/userToDNMapping
Remove LDAP User to DN Mapping
deleteGroupUserSecurityLdapUserToDnMapping 3 params → 202401403404429500
POST
/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify
Verify LDAP Configuration in One Project
verifyGroupUserSecurityLdap 3 params body → 200400401403404429500
GET
/api/atlas/v2/groups/{groupId}/userSecurity/ldap/verify/{requestId}
Return Status of LDAP Configuration Verification in One Project
getGroupUserSecurityLdapVerify 4 params → 200401403404429500

Schemas 11

The contract defines 11 schemas that model the data the API accepts and returns. The most detailed are LDAPSecuritySettings (10 properties), LDAPVerifyConnectivityJobRequestParams (7 properties), ApiError (6 properties), LDAPVerifyConnectivityJobRequest (6 properties). Each schema is shown below with its type and property counts.

DBUserTLSX509Settings
object
Settings to configure TLS Certificates for database users.
2 properties
ApiError
object
6 properties 2 required
Link
object
2 properties
FieldViolation
object
2 properties 2 required
LDAPVerifyConnectivityJobRequestParams
object
Request information needed to verify an Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration. The response does not r…
7 properties 4 required
LDAPSecuritySettings
object
Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configuration details that apply to the specified project.
10 properties
LDAPVerifyConnectivityJobRequest
object
6 properties
UserSecurity
object
3 properties
UserToDNMapping
object
User-to-Distinguished Name (DN) map that MongoDB Cloud uses to transform a Lightweight Directory Access Protocol (LDAP) username into an LDAP DN.
3 properties 1 required
BadRequestDetail
object
Bad request detail.
1 property
LDAPVerifyConnectivityJobRequestValidation
object
One test that MongoDB Cloud runs to test verification of the provided Lightweight Directory Access Protocol (LDAP) over Transport Layer Security (TLS) configur…
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

mongodb-ldap-configuration-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 LDAP Configuration 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.