kowabunga.cloud.user module – Manage Kowabunga users

Note

This module is part of the kowabunga.cloud collection (version 0.1.0).

It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install kowabunga.cloud. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: kowabunga.cloud.user.

Synopsis

• Create, update or delete a Kowabunga user.

Requirements

The below requirements are needed on the host that executes this module.

• python >= 3.8

• kowabunga >= 0.52.5

Parameters

Parameter	Comments
api_key string / required	Private API key used to connect with specified Kowabunga Kahuna endpoint. Recommended to be encrypted using Ansible Vault or SOPS.
description string	Description for the user.
email string / required	Email address for the user. This attribute cannot be updated.
endpoint string / required	HTTPS(S) URI of the Kowabunga Kahuna endpoint. Should be formatted as https://kowabunga.acme.com for example.
name string / required	Name for the user. This attribute cannot be updated.
notifications boolean	Whether the user receives notifications. Choices: false ← (default) true
role string / required	Role assigned to the user. Choices: "superAdmin" "projectAdmin" "user"
state string	Should the resource be present or absent. Choices: "present" ← (default) "absent"

Examples

- name: Create a user
  kowabunga.cloud.user:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: alice
    email: alice@acme.com
    role: user

- name: Delete a user
  kowabunga.cloud.user:
    endpoint: https://kowabunga.acme.com
    api_key: API_KEY
    name: alice
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
user dictionary	Dictionary describing the user. Returned: On success when state is present.
description string	User description Returned: success Sample: "Alice"
email string	User email Returned: success Sample: "alice@acme.com"
id string	User ID Returned: success Sample: "6850281677f2462b6919dbe5"
name string	User name Returned: success Sample: "alice"
notifications boolean	Notifications enabled Returned: success Sample: false
role string	User role Returned: success Sample: "user"

Authors

• The Kowabunga Project

Collection links

• Repository (Sources)