famedly.matrix.matrix_login (0.2.2) — module

Install collection

Install with ansible-galaxy collection install famedly.matrix:==0.2.2

Add to requirements.yml

  collections:
    - name: famedly.matrix
      version: 0.2.2

Description

Log in to a matrix homeserver and get an access token back

Requirements

• matrix-nio (Python library)

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Log in to matrix
  matrix_login:
    hs_url: "https://matrix.org"
    user_id: "{{ matrix_auth_user }}"
    password: "{{ matrix_auth_password }}"

Inputs

    
hs_url:
    description:
    - URL of the homeserver, where the CS-API is reachable
    required: true

user_id:
    description:
    - The user id of the user
    required: true

password:
    description:
    - The password to log in with
    required: true

Outputs

device_id:
  description: The device ID assigned by the server
  returned: When login was successful
  type: str
token:
  description: The access token aquired by logging in
  returned: When login was successful
  type: str