ansible-collection-famedly-matrix/plugins/modules/matrix_logout.py

#!/usr/bin/python
# coding: utf-8

# (c) 2018, Jan Christian Grünhage <jan.christian@gruenhage.xyz>
# (c) 2020-2021, Famedly GmbH
# GNU Affero General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/agpl-3.0.txt)

from __future__ import absolute_import, division, print_function

__metaclass__ = type

ANSIBLE_METADATA = {
    "metadata_version": "1.1",
    "status": ["preview"],
    "supported_by": "community",
}

DOCUMENTATION = """
---
author: "Jan Christian Grünhage (@jcgruenhage)"
module: matrix_logout
short_description: Log out of matrix
description:
    - Invalidate an access token by logging out
options:
    hs_url:
        description:
            - URL of the homeserver, where the CS-API is reachable
        required: true
        type: str
    user_id:
        description:
            - The user id of the user
        required: false
        type: str
    password:
        description:
            - The password to log in with
        required: false
        type: str
    token:
        description:
            - Authentication token for the API call
        required: false
        type: str
requirements:
    -  matrix-nio (Python library)
"""

EXAMPLES = """
- name: Invalidate access token
  matrix_logout:
    hs_url: "https://matrix.org"
    token: "{{ matrix_auth_token }}"
"""

RETURN = """
"""
import asyncio

from ansible_collections.famedly.matrix.plugins.module_utils.matrix import (
    AnsibleNioModule,
)


async def run_module():
    result = dict(
        changed=False,
    )

    module = AnsibleNioModule(user_logout=True)
    await module.matrix_login()
    await module.matrix_logout()
    await module.exit_json(**result)


def main():
    asyncio.run(run_module())


if __name__ == "__main__":
    main()