community.mongodb.mongodb_atlas_user (1.7.3) — module

Install collection

Install with ansible-galaxy collection install community.mongodb:==1.7.3

Add to requirements.yml

  collections:
    - name: community.mongodb
      version: 1.7.3

Description

The mongodb_atlas_user module lets you create, modify and delete the database users in your cluster.

Each user has a set of roles that provide access to the project's databases.

A user's roles apply to all the clusters in the project

if two clusters have a products database and a user has a role granting read access on the products database,

the user has that access on both clusters.

L(API Documentation,https://docs.atlas.mongodb.com/reference/api/database-users/)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

    - 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

Inputs

    
roles:
    description:
    - Array of this user's roles and the databases / collections on which the roles apply.
    - A role must include following elements
    elements: dict
    required: true
    suboptions:
      database_name:
        aliases:
        - databaseName
        description:
        - Database on which the user has the specified role.
        - A role on the admin database can include privileges that apply to the other
          databases.
        required: true
        type: str
      role_name:
        aliases:
        - roleName
        description:
        - Name of the role. This value can either be a built-in role or a custom role.
        required: true
        type: str
    type: list

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the ressource.
    type: str

scopes:
    default: []
    description:
    - List of clusters and Atlas Data Lakes that this user can access.
    - Atlas grants database users access to all resources by default.
    elements: dict
    required: false
    suboptions:
      name:
        description:
        - Name of the cluster or Atlas Data Lake that the database user can access.
        required: true
        type: str
      type:
        choices:
        - CLUSTER
        - DATA_LAKE
        default: CLUSTER
        description:
        - Type of resource that the database user can access.
        type: str
    type: list

group_id:
    aliases:
    - groupId
    description:
    - Unique identifier for the Atlas project.
    required: true
    type: str

password:
    description:
    - User's password.
    required: true
    type: str

username:
    description:
    - Username for authenticating to MongoDB.
    required: true
    type: str

api_password:
    aliases:
    - apiPassword
    description:
    - The password for use in authentication with the Atlas API.
    - Can use API users and tokens (private key is password)
    required: true
    type: str

api_username:
    aliases:
    - apiUsername
    description:
    - The username for use in authentication with the Atlas API.
    - Can use API users and tokens (public key is username)
    required: true
    type: str

database_name:
    aliases:
    - databaseName
    choices:
    - admin
    - $external
    default: admin
    description:
    - Database against which Atlas authenticates the user.
    type: str