atlas security ldap save
保存项目的 LDAP 配置。
要使用此命令,您必须使用具有项目所有者角色的用户帐户或 API 密钥进行身份验证。
语法
命令语法
atlas security ldap save [options]
选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
--authenticationEnabled | false | 指示是否启用 LDAP 用户身份验证的标志。 | |
--authorizationEnabled | false | 指示是否启用 LDAP 用户授权的标志。 | |
--authzQueryTemplate | 字符串 | false | Atlas 执行 RFC 4515 格式或 RFC 4516 格式的 LDAP 查询模板,用于获取经过身份验证的用户所属的 LDAP 授权组。 使用 URL 中的 {USER} 占位符来替换用户名。该查询是相对于主机名指定的主机而言的。 |
--bindPassword | 字符串 | false | 用于验证 bindUsername 的密码。 |
--bindUsername | 字符串 | true | Atlas 用于连接 LDAP 服务器的用户标识名 (DN)。 您必须根据 RFC 2253 设置 LDAP 标识名的格式。 |
--caCertificate | 字符串 | false | 用于验证 LDAP 服务器身份的证书颁发机构 (CA)。 要删除分配的值,请传递空字符串。 |
-h,--help | false | 保存帮助 | |
--hostname | 字符串 | true | LDAP 服务器的主机名或 IP 地址。 |
--mappingLdapQuery | 字符串 | false | RFC 4515 格式或 RFC 4516 格式的 LDAP 查询模板,该模板将正则表达式匹配的 LDAP 名称插入 LDAP 查询 URI。 与 --mappingSubs CN 互斥。 |
--mappingMatch | 字符串 | false | ECMAScript 格式的正则表达式 (regex),用于与提供的用户名进行匹配。 |
--mappingSubstitution | 字符串 | false | LDAP 标识名 (DN) 模板,用于将与匹配选项中指定的正则表达式匹配的 LDAP 用户名转换为 LDAP DN。 与 --mappingLdapQuery、--mappingLdapQuery 互斥。 |
-o, --output | 字符串 | false | 输出格式。 有效值为 json、json-path、go-template 或 go-template-file。 要查看完整输出,请使用 -o json 选项。 |
--port | int | false | LDAP 服务器侦听客户端连接的端口。 此值默认为 636。 |
--projectId | 字符串 | false | 标识要使用的项目的十六进制字符串。 此选项会覆盖配置文件或环境变量中的设置。 |
继承选项
名称 | 类型 | 必需 | 说明 |
---|---|---|---|
-P, --profile | 字符串 | false | 要从配置文件中使用的配置文件的名称。 要了解 Atlas CLI 的配置文件,请参阅 https://dochub.mongodb.org/core/atlas-cli-save-connection-settings。 |
输出
如果命令成功,CLI 将返回类似于以下示例的输出。 括号中的值代表您的价值观。
HOSTNAME PORT AUTHENTICATION AUTHORIZATION <Ldap.Hostname> <Ldap.Port> <Ldap.AuthenticationEnabled> <Ldap.AuthorizationEnabled>
示例
# Save an LDAP server configuration to authenticate and authorize MongoDB users for the host atlas-ldaps-01.ldap.myteam.com: atlas security ldap save --authenticationEnabled --authorizationEnabled --hostname atlas-ldaps-01.ldap.myteam.com --bindUsername "CN=Administrator,CN=Users,DC=atlas-ldaps-01,DC=myteam,DC=com" --bindPassword changeMe