ansible-collection-famedly-.../plugins/modules/matrix_logout.py
Jadyn Emma Jaeger 0a4af363d3
refactor(modules): add matrix_utils.AnsibleNioModule helper class, edit all modules accordingly
Matrix Login can be performed with username/password or token from each module.
`matrix_[uia]_login` and `matrix_logout` is only needed, longer operations are wanted.
modules called with username/password will logout automatically.
The login/logout process is handled by the helper class (except matrix_uia_login).
2021-04-19 10:14:49 +02:00

65 lines
1.4 KiB
Python

#!/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
token:
description:
- Authentication token for the API call
required: true
requirements:
- matrix-nio (Python library)
'''
EXAMPLES = '''
- name: Invalidate access token
matrix_logout:
hs_url: "https://matrix.org"
token: "{{ matrix_auth_token }}"
'''
RETURN = '''
'''
import traceback
import asyncio
from ansible_collections.famedly.matrix.plugins.module_utils.matrix import *
async def run_module():
result = dict(
changed=False,
)
module = AnsibleNioModule()
await module.matrix_login()
await module.matrix_logout()
await module.exit_json(**result)
def main():
asyncio.run(run_module())
if __name__ == '__main__':
main()