> For the complete documentation index, see [llms.txt](https://docs.ionos.com/cloud/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ionos.com/cloud/ansible/api/dbaas-mongo/modules/mongo_cluster_user.md). # Mongo Cluster User ## mongo\_cluster\_user This is a module that supports creating and destroying Mongo Cluster Users ### Example Syntax ```yaml name: Create Cluster User ionoscloudsdk.ionoscloud.mongo_cluster_user: mongo_cluster: '' mongo_username: testuser mongo_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' user_roles: - role: read database: test register: mongo_user_response name: Update User ionoscloudsdk.ionoscloud.mongo_cluster_user: mongo_cluster: '' mongo_username: testuser mongo_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' user_roles: - role: read database: test - role: readWrite database: test state: update register: mongo_user_response name: Delete Cluster User ionoscloudsdk.ionoscloud.mongo_cluster_user: mongo_cluster: '' mongo_username: testuser state: absent register: mongo_user_response ``` ### Returned object ```json { "changed": true, "failed": false, "action": "create", "mongo_cluster_user": { "type": "user", "metadata": { "created_date": "2023-05-30T14:20:09+00:00", "created_by": "", "created_by_user_id": "" }, "properties": { "username": "testuser", "password": null, "roles": [ { "role": "read", "database": "test" } ] } } } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/dbaas-mongo). ## state: **present** ```yaml name: Create Cluster User ionoscloudsdk.ionoscloud.mongo_cluster_user: mongo_cluster: '' mongo_username: testuser mongo_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' user_roles: - role: read database: test register: mongo_user_response ``` #### Available parameters for state **present**:

Name	Required	Description
mongo_cluster str	True	The UUID or name of an existing Mongo Cluster.
mongo_username str	True	The username of the user.
mongo_password str	True	The password of the user.
user_roles list	True	A list of mongodb user roles. A user role is represented as a dict containing 2 keys:'role': has one of the following values: 'read', 'readWrite' or 'readAnyDatabase''database': the name of the databse to which the role applies
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'update', 'absent']

## state: **update** ```yaml name: Update User ionoscloudsdk.ionoscloud.mongo_cluster_user: mongo_cluster: '' mongo_username: testuser mongo_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' user_roles: - role: read database: test - role: readWrite database: test state: update register: mongo_user_response ``` #### Available parameters for state **update**:

Name	Required	Description
mongo_cluster str	True	The UUID or name of an existing Mongo Cluster.
mongo_username str	True	The username of the user.
mongo_password str	False	The password of the user.
user_roles list	False	A list of mongodb user roles. A user role is represented as a dict containing 2 keys:'role': has one of the following values: 'read', 'readWrite' or 'readAnyDatabase''database': the name of the databse to which the role applies
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'update', 'absent']

## state: **absent** ```yaml name: Delete Cluster User ionoscloudsdk.ionoscloud.mongo_cluster_user: mongo_cluster: '' mongo_username: testuser state: absent register: mongo_user_response ``` #### Available parameters for state **absent**:

Name	Required	Description
mongo_cluster str	True	The UUID or name of an existing Mongo Cluster.
mongo_username str	True	The username of the user.
api_url str	False	The Ionos API base URL.
certificate_fingerprint str	False	The Ionos API certificate fingerprint.
username str	False	The Ionos username. Overrides the IONOS_USERNAME environment variable.
password str	False	The Ionos password. Overrides the IONOS_PASSWORD environment variable.
token str	False	The Ionos token. Overrides the IONOS_TOKEN environment variable.
wait bool	False	Wait for the resource to be created before returning. Default: True Options: [True, False]
wait_timeout int	False	How long before wait gives up, in seconds. Default: 600
state str	False	Indicate desired state of the resource. Default: present Options: ['present', 'update', 'absent']

--- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.ionos.com/cloud/ansible/api/dbaas-mongo/modules/mongo_cluster_user.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.