mirror of
https://github.com/element-hq/matrix-authentication-service.git
synced 2026-03-30 19:25:47 +00:00
104 lines
2.5 KiB
Markdown
104 lines
2.5 KiB
Markdown
# `manage`
|
|
|
|
|
|
The MAS CLI provides several subcommands for managing users and configurations
|
|
|
|
Global options:
|
|
- `--config <config>`: Path to the configuration file.
|
|
- `--help`: Print help.
|
|
|
|
## `manage add-email`
|
|
|
|
Add an email address to the specified user.
|
|
|
|
```
|
|
$ mas-cli manage add-email <username> <email>
|
|
```
|
|
|
|
## `manage verify-email`
|
|
|
|
[DEPRECATED] Mark an email address as verified.
|
|
|
|
```
|
|
$ mas-cli manage verify-email <username> <email>
|
|
```
|
|
|
|
## `manage set-password`
|
|
|
|
Set a user password.
|
|
|
|
Options:
|
|
- `--ignore-complexity`: Don't enforce that the password provided is above the minimum configured complexity.
|
|
|
|
```
|
|
$ mas-cli manage set-password <username> <password> --ignore-complexity
|
|
```
|
|
|
|
## `manage issue-compatibility-token`
|
|
|
|
Issue a compatibility token for a user.
|
|
|
|
Options:
|
|
- `--device-id <device_id>`: Device ID to set in the token. If not specified, a random device ID will be generated.
|
|
- `--yes-i-want-to-grant-synapse-admin-privileges`: Whether the token should be given admin privileges.
|
|
|
|
```
|
|
$ mas-cli manage issue-compatibility-token <username> --device-id <device_id> --yes-i-want-to-grant-synapse-admin-privileges
|
|
```
|
|
|
|
## `manage provision-all-users`
|
|
|
|
Trigger a provisioning job for all users.
|
|
|
|
```
|
|
$ mas-cli manage provision-all-users
|
|
```
|
|
|
|
## `manage kill-sessions`
|
|
|
|
Kill all sessions for a user.
|
|
|
|
Options:
|
|
- `--dry-run`: Do a dry run, ie see which sessions would be killed.
|
|
|
|
```
|
|
$ mas-cli manage kill-sessions <username> --dry-run
|
|
```
|
|
|
|
## `manage lock-user`
|
|
|
|
Lock a user.
|
|
|
|
Options:
|
|
- `--deactivate`: Whether to deactivate the user.
|
|
|
|
```
|
|
$ mas-cli manage lock-user <username> --deactivate
|
|
```
|
|
|
|
## `manage unlock-user`
|
|
|
|
Unlock a user.
|
|
|
|
```
|
|
$ mas-cli manage unlock-user <username>
|
|
```
|
|
|
|
## `manage register-user`
|
|
|
|
Register a user. This will interactively prompt for the user's attributes unless the `--yes` flag is set. It bypasses any policy check on the password, email, etc.
|
|
|
|
Options:
|
|
- `--username <username>`: Username to register.
|
|
- `--password <password>`: Password to set.
|
|
- `--email <email>`: Email to add. Can be specified multiple times.
|
|
- `--upstream-provider-mapping <UPSTREAM_PROVIDER_ID:SUBJECT>`: Upstream OAuth 2.0 provider mapping. Can be specified multiple times.
|
|
- `--admin`: Make the user an admin.
|
|
- `--no-admin`: Make the user not an admin.
|
|
- `--yes`: Don't ask questions, just do it.
|
|
- `--display-name <display_name>`: Set the user's display name.
|
|
- `--ignore-password-complexity`: Don't enforce that the password provided is above the minimum configured complexity.
|
|
|
|
```
|
|
$ mas-cli manage register-user
|
|
``` |