community.mongodb.mongodb_atlas_ldap_user 模块 – 在 Atlas 中管理 LDAP 用户

注意

此模块是 community.mongodb 集合 (版本 1.7.8) 的一部分。

如果您正在使用 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用:ansible-galaxy collection install community.mongodb

要在 playbook 中使用它,请指定:community.mongodb.mongodb_atlas_ldap_user

概要

  • mongodb_atlas_ldap_user 模块允许您通过将 LDAP 组映射到 Atlas 数据库上的 MongoDB 角色来在 admin 数据库上创建 LDAP 组。

  • 每个用户或组都有一组角色,这些角色提供对项目数据库的访问权限。

  • API 文档

参数

参数

注释

api_password

别名:apiPassword

字符串 / 必需

用于与 Atlas API 进行身份验证的密码。

可以使用 API 用户和令牌(私钥为密码)

api_username

别名:apiUsername

字符串 / 必需

用于与 Atlas API 进行身份验证的用户名。

可以使用 API 用户和令牌(公钥为用户名)

database_name

别名:databaseName

字符串

Atlas 用于对用户进行身份验证的数据库。

选项

  • "admin" ← (默认)

  • "$external"

group_id

别名:groupId

字符串 / 必需

Atlas 项目的唯一标识符。

ldap_auth_type

别名:ldapAuthType

字符串

用户的 LDAP 授权类型,例如 USER 或 GROUP

选项

  • "GROUP" ← (默认)

  • "USER"

角色

列表 / 元素=字典 / 必需

此用户的角色数组以及角色适用的数据库/集合。

角色必须包含以下元素

database_name

别名:databaseName

字符串 / 必需

用户拥有指定角色的数据库。

admin 数据库上的角色可以包含适用于其他数据库的权限。

role_name

别名:roleName

字符串 / 必需

角色名称。此值可以是内置角色或自定义角色。

状态

字符串

资源的状态。

选项

  • "present" ← (默认)

  • "absent"

用户名

字符串 / 必需

用于向 MongoDB 进行身份验证的用户名。

示例

- name: LDAP Group or Username
  community.mongodb.mongodb_atlas_ldap_user:
    api_username: "API_user"
    api_password: "API_passwort_or_token"
    atlas_ldap_user: "USER DN or GROUP DN"
    group_id: "GROUP_ID"
    database_name: "admin"
    username: my_app_user
    roles:
      - database_name: private_info
        role_name: read
      - database_name: public_info
        role_name: readWrite

作者

  • Martin Schurz (@schurzi) / Derek Giri