atlas api ldapConfiguration
Public Preview: please provide feedback: Returns, edits, verifies, and removes LDAP configurations.
Public Preview: The atlas api sub-command, automatically generated from the MongoDB Atlas Admin API, offers full coverage of the Admin API and is currently in Public Preview (please provide feedback at https://feedback.mongodb.com/forums/930808-atlas-cli). Admin API capabilities have their own release lifecycle, which you can check via the provided API endpoint documentation link.
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.
Options
Name | Type | Required | Description |
|---|---|---|---|
-h, --help | false | help for ldapConfiguration |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Name of the profile to use from your configuration file. To learn about profiles for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-save-connection-settings. |
Related Commands
atlas api ldapConfiguration deleteLdapConfiguration - Public Preview: please provide feedback: Removes the current LDAP Distinguished Name mapping captured in the userToDNMapping document from the LDAP configuration for the specified project.
atlas api ldapConfiguration getLdapConfiguration - Public Preview: please provide feedback: Returns the current LDAP configuration for the specified project.
atlas api ldapConfiguration getLdapConfigurationStatus - Public Preview: please provide feedback: Returns the status of one request to verify one LDAP configuration for the specified project.
atlas api ldapConfiguration saveLdapConfiguration - Public Preview: please provide feedback: Edits the LDAP configuration for the specified project.
atlas api ldapConfiguration verifyLdapConfiguration - Public Preview: please provide feedback: Verifies the LDAP configuration for the specified project.