Docs Menu

LDAP Configuration

Use the following endpoints to verify and save an LDAP configuration for an Atlas project. An LDAP configuration defines settings for Atlas 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 Atlas cluster with VPC Peering. In addition, your LDAP server must use TLS.

Note

You must have the Atlas admin user privilege to use these endpoints.

In addition, to configure user authentication and authorization with LDAPS, your cluster must run MongoDB 3.6 or later. Groups for which you have configured LDAPS can not create a cluster using a version of MongoDB before 3.6 or later.

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.

https://cloud.mongodb.com/api/atlas/v1.0

Method
Endpoint
Description
POST
Request verification of an LDAP configuration. Use this endpoint to test your LDAP configuration details before saving them.
GET
Retrieve the status of a request for verification of an LDAP configuration.
PATCH

Save an LDAP configuration for a Atlas project.

If you change your LDAP configuration, Atlas performs a rolling restart of your cluster. This restart allows Atlas to use the correct settings to authenticate users.

GET
Get the current LDAP configuration for an Atlas project.
DELETE

Delete the current userToDNMapping from the LDAP configuration for an Atlas project.

If you change your LDAP configuration, Atlas performs a rolling restart of your cluster. This restart allows Atlas to use the correct settings to authenticate users.

←  Disable Customer-Managed X.509Verify One LDAP Configuration →
Give Feedback
© 2022 MongoDB, Inc.

About

  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2022 MongoDB, Inc.