# User ## user This module allows you to create, update or remove a user. ### Example Syntax ```yaml name: Create user check 1 ionoscloudsdk.ionoscloud.user: firstname: John lastname: Doe email: '' administrator: false user_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' force_sec_auth: false state: present check_mode: true diff: true register: user_response name: Add user to first group ionoscloudsdk.ionoscloud.user: user: '' groups: - 'AnsibleAutoTestUM 1' state: update name: Delete user ionoscloudsdk.ionoscloud.user: user: '' state: absent check_mode: true diff: true register: user_response ``` ### Returned object ```json { "changed": true, "failed": false, "action": "create", "user": { "entities": null, "href": "https://api.ionos.com/cloudapi/v6/um/users/", "id": "", "metadata": { "created_date": "2023-05-31T13:41:25+00:00", "etag": "37a6259cc0c1dae299a7866489dff0bd", "last_login": null }, "properties": { "active": true, "administrator": false, "email": "", "firstname": "John2", "force_sec_auth": false, "lastname": "Doe", "s3_canonical_user_id": null, "sec_auth_active": false }, "type": "user" } } ``` #### For more examples please check out the tests [here](https://github.com/ionos-cloud/module-ansible/tree/master/tests/user-management). ## state: **present** ```yaml name: Create user check 1 ionoscloudsdk.ionoscloud.user: firstname: John lastname: Doe email: '' administrator: false user_password: '{{ lookup('ansible.builtin.password', '/dev/null chars=ascii_letters,digits') }}' force_sec_auth: false state: present check_mode: true diff: true register: user_response ``` #### Available parameters for state **present**:

Name	Required	Description
firstname str	True	The first name of the user.
lastname str	True	The last name of the user.
email str	True	The email address of the user.
user_password str	True	A password for the user.
administrator bool	False	Indicates if the user has admin rights.
force_sec_auth bool	False	Indicates if secure authentication should be forced on the user.
groups list	False	A list of group IDs or names where the user (non-administrator) is to be added. Set to empty list ([]) to remove the user from all groups.
sec_auth_active bool	False	Indicates if secure authentication is active for the user.
ignored_properties list	False	A list of field to ignore changes to when evaluating whether to make changes to the ionos resource. These fields will still be used when creating or recreating the resource, but will not cause the operation themselves Default:
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', 'absent', 'update']

## state: **absent** ```yaml name: Delete user ionoscloudsdk.ionoscloud.user: user: '' state: absent check_mode: true diff: true register: user_response ``` #### Available parameters for state **absent**:

Name	Required	Description
user str	True	The ID or name 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', 'absent', 'update']

## state: **update** ```yaml name: Add user to first group ionoscloudsdk.ionoscloud.user: user: '' groups: - 'AnsibleAutoTestUM 1' state: update ``` #### Available parameters for state **update**:

Name	Required	Description
firstname str	False	The first name of the user.
lastname str	False	The last name of the user.
email str	False	The email address of the user.
user str	True	The ID or name of the user.
user_password str	False	A password for the user.
administrator bool	False	Indicates if the user has admin rights.
force_sec_auth bool	False	Indicates if secure authentication should be forced on the user.
groups list	False	A list of group IDs or names where the user (non-administrator) is to be added. Set to empty list ([]) to remove the user from all groups.
sec_auth_active bool	False	Indicates if secure authentication is active for the user.
ignored_properties list	False	A list of field to ignore changes to when evaluating whether to make changes to the ionos resource. These fields will still be used when creating or recreating the resource, but will not cause the operation themselves Default:
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', 'absent', 'update']

--- # Agent Instructions: 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: ``` GET https://docs.ionos.com/ansible/api/user-management/modules/user.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.