An open API service indexing awesome lists of open source software.

https://github.com/digitalist-open-cloud/matomo-plugin-userconsole

Userconsole for Matomo
https://github.com/digitalist-open-cloud/matomo-plugin-userconsole

matomo matomo-cli matomo-plugin

Last synced: 9 months ago
JSON representation

Userconsole for Matomo

Awesome Lists containing this project

README

          

# Matomo UserConsole Plugin

## Usage

This plugin adds the possibility to work with users via console commands.

## Console commands

* [user:access](#useraccess)
* [user:create](#usercreate)
* [user:invite](#userinvite)
* [user:delete](#userdelete)
* [user:list](#userlist)
* [user:make-super](#makesuper)
* [user:remove-super](#removesuper)
* [user:reset-password](#resetpassword)

### user:create

Creates a user.

Options:

* `login` User name for the user (required)
* `email` Email for the user (required)
* `password` Password for the user (required)
* `super` Add super user privileges to the user (optional)

### user:invite

Invites a user.

Options:

* `login` User name for the user (required)
* `email` Email for the user (required)
* `site` ID of the initial site (required)
* `expiry` Expiry in days (optional)

### user:delete

Deletes a user.

Options:

* `login` User name for the user (required)

### user:access

Menage access to a user, for which sites and what access.

Options:

* `login` User name for the user (required)
* `sites` One or more sites that you would like to set the permission for (required)
* `access` Which access the user should have to the site - `noaccess`, `view`, `write`, `admin` (required)

### user:make-super

Adds super user privileges to a user

Options:

* `login` User name for the user (required)

### user:remove-super

Remove super user privileges from a user

Options:

- `login` User name for the user (required)

If the user is the only one that has super user access, this will fail. At least one super user is needed.

### user:list

List all users.

No options.

### user:reset-password

Resets password for a user.

Options:

- `login` User name for the user (required)
- `new-password` New password for the user (required)