famedly.matrix.synapse_register (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

register a matrix user using synapse's admin API

Usage examples

Scanned by Steampunk Spotter

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

- name: Log in to matrix
  synapse_register:
    hs_url: "https://matrix.org"
    user_id: "{{ matrix_auth_user }}"
    password: "{{ matrix_auth_password }}"
    admin: true
    shared_secret: "long secret string"

Inputs

    
admin:
    default: false
    description:
    - Whether or not the new user should be an admin
    required: false
    type: bool

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 register with
    required: true

shared_secret:
    description:
    - Shared secret to authenticate registration request
    required: true