Docs Menu
Docs Home
/ /
Atlas CLI
/ / /

atlas security ldap verify

On this page

  • Syntax
  • Options
  • Inherited Options
  • Output
  • Examples
  • Related Commands

Request verification of an LDAP configuration for your project.

To use this command, you must authenticate with a user account or an API key with the Project Owner role.

Command Syntax
atlas security ldap verify [options]
Name
Type
Required
Description
--authzQueryTemplate
string
false
RFC 4515-formatted or RFC 4516-formatted LDAP query template that Atlas executes to obtain the LDAP authorization groups to which the authenticated user belongs. Use the {USER} placeholder in the URL to substitute the username. The query is relative to the host specified with the hostname.
--bindPassword
string
false
Password used to authenticate the bindUsername.
--bindUsername
string
true
User distinguished name (DN) that Atlas uses to connect to the LDAP server. You must format LDAP distinguished names according to RFC 2253.
--caCertificate
string
false
Certificate Authority (CA) used to verify the identity of the LDAP server. To delete an assigned value, pass an empty string.
-h, --help
false
help for verify
--hostname
string
true
Hostname or IP address of the LDAP server.
-o, --output
string
false
Output format. Valid values are json, json-path, go-template, or go-template-file. To see the full output, use the -o json option.
--port
int
false
Port that the LDAP server listens to for client connections. This value defaults to 636.
--projectId
string
false
Hexadecimal string that identifies the project to use. This option overrides the settings in the configuration file or environment variable.
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.

If the command succeeds, the CLI returns output similar to the following sample. Values in brackets represent your values.

REQUEST ID PROJECT ID STATUS
<RequestId> <GroupId> <Status>
# Request the JSON-formatted verification of the LDAP configuration for the atlas-ldaps-01.ldap.myteam.com host in the project with the ID 5e2211c17a3e5a48f5497de3:
atlas security ldap verify --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" --bindPassword changeMe --projectId 5e2211c17a3e5a48f5497de3 --output json
← save