mongocli atlas security ldap save
On this page
mongocli atlas commands are now deprecated because there's a new, dedicated CLI available for Atlas users. Migrate to the Atlas CLI to enjoy the same capabilities and the latest features. You can use mongocli atlas commands until April 30, 2023.Save an LDAP configuration.
Syntax
mongocli atlas security ldap save [options]
Options
Name | Type | Required | Description |
|---|---|---|---|
--authenticationEnabled | false | Specifies whether user authentication with LDAP is enabled. | |
--authorizationEnabled | false | Specifies whether user authorization with LDAP is enabled. | |
--authzQueryTemplate | string | false | An LDAP query template that Atlas executes to obtain the LDAP groups to which the authenticated user belongs. |
--bindPassword | string | false | Password used to authenticate the bindUsername. |
--bindUsername | string | true | The user distinguished name (DN) that Atlas uses to connect to the LDAP server. |
--caCertificate | string | false | CA certificate used to verify the identify of the LDAP server. |
-h, --help | false | help for save | |
--hostname | string | true | Hostname or IP address of the LDAP server. |
--mappingLdapQuery | string | false | An LDAP query formatting template that inserts the authentication name matched by the match regex into an LDAP query URI encoded respecting RFC4515 and RFC4516. |
--mappingMatch | string | false | An ECMAScript-formatted regular expression (regex) to match against a provided username. |
--mappingSubstitution | string | false | An LDAP distinguished name (DN) formatting template that converts the authentication name matched by the match regex into a LDAP DN. |
-o, --output | string | false | Output format. Valid values are json, json-path, go-template, or go-template-file. |
--port | int | false | Port to which the LDAP server listens to for client connections. This value defaults to 636. |
--projectId | string | false | Project ID to use. Overrides the settings in the configuration file or environment variable. |
Inherited Options
Name | Type | Required | Description |
|---|---|---|---|
-P, --profile | string | false | Profile to use from your configuration file. |