модуль community.mongodb.mongodb_atlas_user — управление пользователями баз данных в Atlas

Примечание

Этот модуль является частью коллекции community.mongodb (версия 1.7.12).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.mongodb.

Чтобы использовать её в плейбуке, укажите: community.mongodb.mongodb_atlas_user.

Краткое описание
Параметры
Примеры

Краткое описание

Модуль mongodb_atlas_user позволяет создавать, изменять и удалять пользователей баз данных в вашем кластере.
Каждому пользователю назначен набор ролей, предоставляющих доступ к базам данных проекта.
Роли пользователя применяются ко всем кластерам проекта.
Если в двух кластерах есть база данных products, а роль пользователя предоставляет доступ на чтение к базе данных products,
пользователь получает этот доступ в обоих кластерах.
Документация API

Параметры

Параметр	Комментарии
api_password псевдонимы: apiPassword строка / обязательно	Пароль для аутентификации в API Atlas. Можно использовать пользователей и токены API (закрытый ключ используется как пароль).
api_username псевдонимы: apiUsername строка / обязательно	Имя пользователя для аутентификации в API Atlas. Можно использовать пользователей и токены API (открытый ключ используется как имя пользователя).
database_name псевдонимы: databaseName строка	База данных, используемая Atlas для аутентификации пользователя. Варианты: `"admin"` ← (по умолчанию) `"$external"`
group_id псевдонимы: groupId строка / обязательно	Уникальный идентификатор проекта Atlas.
password строка / обязательно	Пароль пользователя.
roles список / элементы=словарь / обязательно	Массив ролей пользователя и баз данных / коллекций, к которым применяются эти роли. Роль должна содержать следующие элементы
database_name псевдонимы: databaseName строка / обязательно	База данных, к которой пользователь имеет указанные права роли. Роль для базы данных admin может включать привилегии, применяемые к другим базам данных.
role_name псевдонимы: roleName строка / обязательно	Имя роли. Это может быть встроенная или пользовательская роль.
scopes список / элементы=словарь	Список кластеров и хранилищ данных Atlas, к которым этот пользователь может получить доступ. По умолчанию Atlas предоставляет пользователям баз данных доступ ко всем ресурсам. По умолчанию: `[]`
name строка / обязательно	Имя кластера или хранилища данных Atlas, к которому пользователь базы данных может получить доступ.
type строка	Тип ресурса, к которому пользователь базы данных может получить доступ. Варианты: `"CLUSTER"` ← (по умолчанию) `"DATA_LAKE"`
state строка	Состояние ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
username строка / обязательно	Имя пользователя для аутентификации в MongoDB.

Примеры

- name: test user
  community.mongodb.mongodb_atlas_user:
    api_username: "API_user"
    api_password: "API_passwort_or_token"
    group_id: "GROUP_ID"
    username: my_app_user
    password: SuperSecret!
    roles:
      - database_name: private_info
        role_name: read
      - database_name: public_info
        role_name: readWrite

Авторы

Martin Schurz (@schurzi)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/mongodb/mongodb_atlas_user_module.html