mz user

The mz user command manages users in your organization.

create

Invite a user to your organization.

mz user create <EMAIL> <NAME> [options...]

Arguments

Flag Environment variables Description
<EMAIL> Required. Set the email address of the user.
<NAME> Required. Set the name of the user.
--profile=<PROFILE> MZ_PROFILE Use the specified authentication profile.

Examples

Invite Franz Kafka to your organization:

mz user create franz@kafka.org "Franz Kafka"

list, ls

List all users in your organization.

mz user {list,ls} [options...]

Arguments

Argument Environment variables Description
--profile=<PROFILE> MZ_PROFILE Use the specified authentication profile.

Examples

List all users in your organization:

$ mz user list
Email            | Name
-----------------|-------------
franz@kafka.org  | Franz Kafka

remove, rm

Remove a user from your organization.

mz user {remove,rm} <EMAIL> [options...]

Arguments

Argument Environment variables Description
<EMAIL> Required. The email address of the user to remove.
--profile=<PROFILE> MZ_PROFILE Use the specified authentication profile.

Examples

Remove Franz Kafka from your organization:

mz user remove franz@kafka.org

Global arguments

Argument Environment variables Description
‑‑config MZ_CONFIG Set the configuration file.
Default: $HOME/.config/materialize/mz.toml.
‑f, ‑‑format MZ_FORMAT Set the output format: text , json, or csv.
Default: text.
‑‑no‑color NO_COLOR, MZ_NO_COLOR Disable color output.
‑‑help Display help and exit.
‑‑version Display version and exit.
Back to top ↑