actions.yaml

# Copyright 2025 Canonical Ltd.
# See LICENSE file for licensing details.

anonymize-user:
  description: |
    Anonymizes an user in order to make it GDPR compliant.
  properties:
    username:
      description: |
        User name to be anonymized.
      type: string
  required:
    - username
register-user:
  description: |
    Registers a user for the Synapse server.
    You need to supply a user name and whether that user should be an admin or not.
  properties:
    username:
      description: |
        When not using SSO, a user name is needed
        for the creation of a matrix account.
      type: string
    admin:
      description: Whether to create an admin user.
      type: boolean
      default: false
  required:
    - username
verify-user-email:
  description: |
    Verify an user's email.
    You need to supply an username and the email to verify.
  properties:
    username:
      description: The username.
      type: string
    email:
      description: The email to verify.
      type: string
  required:
    - username
    - email
create-backup:
  description: |
    Creates a backup to s3 storage.
list-backups:
  description: |
    Lists backups in s3 storage.
restore-backup:
  description:  |
    Restore a Synapse backup.
    S3 credentials are retrieved from the relation with the S3 integrator charm.
    The server_name and filesystem configuration for the application should be
    identical to the application restored.
  params:
    backup-id:
      type: string
      description: The backup-id to identify the backup to restore.
  required:
    - backup-id
delete-backup:
  description: |
    Delete a backup in s3 storage by backup-id.
  params:
    backup-id:
      type: string
      description: The backup-id to identify the backup to delete.
  required:
    - backup-id