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

97 lines
2.1 KiB
Python
Raw Normal View History

#!/usr/bin/python
# coding: utf-8
# (c) 2018, Jan Christian Grünhage <jan.christian@gruenhage.xyz>
# (c) 2020, 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)"
2020-02-14 11:42:54 +00:00
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
2020-02-14 11:42:54 +00:00
matrix_logout:
hs_url: "https://matrix.org"
token: "{{ matrix_auth_token }}"
'''
RETURN = '''
'''
import traceback
import asyncio
from ansible.module_utils.basic import AnsibleModule, missing_required_lib
MATRIX_IMP_ERR = None
try:
from nio import AsyncClient
except ImportError:
MATRIX_IMP_ERR = traceback.format_exc()
MATRIX_FOUND = False
else:
MATRIX_FOUND = True
async def run_module():
module_args = dict(
hs_url=dict(type='str', required=True),
token=dict(type='str', required=True, no_log=True),
)
result = dict(
changed=False,
)
module = AnsibleModule(
argument_spec=module_args,
supports_check_mode=True
)
if not MATRIX_FOUND:
module.fail_json(msg=missing_required_lib('matrix-nio'), exception=MATRIX_IMP_ERR)
if module.check_mode:
return result
# create a client object
client = AsyncClient(module.params['hs_url'])
2020-02-14 01:24:05 +00:00
client.access_token = module.params['token']
# log out
await client.logout()
# close client sessions
await client.close()
module.exit_json(**result)
def main():
asyncio.run(run_module())
if __name__ == '__main__':
main()