.

The users commands

The S1 system supports multiple users. When you are logged in through the S1-CLI client you can list all users, create new users, edit, or delete users.

Creating a new user

To create a new user, use the users create command.

Usage:

users create <name> --password=<password> --role=<prm> --email=<email>

Options

Options and arguments Description
<name> Positional argument, replace <name> with the name of the new user.
--password=<password> Make a password for the new user, <password> with your chosen password.
--role=<prm> Role for the newly created user. Replace <prm> with either Read, ReadWrite, or Admin role.
--email=<email> Specify the email address of the newly created user. Replace <email> with an email address.

Notice:

  1. Password must include:
    • Both numbers and characters
    • At least one upper-case character
    • At least 8 characters
  2. In the login process, the user may be required to insert a login token sent to their email, (see also Two-factor authentication).

Examples

  1. To create a user Joe with permissions to read and write, password free4Ever, and email joe@mct.com, run users create Joe --password free4ever --role ReadWrite --email joe@mct.com
  2. To create a user Jane with permissions Admin, password have2Seat, and email jane@protonmail.com, run users create Jane --password have2seat --role Admin --email jane@protonmail.com

Listing all users

To list all users, use the users list command.

Usage:

users list [<name>] [--role=<permissions>]

Options

Options and arguments Description
<name> Positional argument, display only information about the specified user name.
--role=<permissions> List only users with specified role.

Examples

  1. To list all users, run the command users list
  2. To display user information for users Albert and Jane, run users list Albert Jane

Deleting a user

To delete a user, log in as Admin user and use the users delete command

Usage:

```users delete <name>```

Options

Options and arguments Description
<name> Positional argument, replace <name> with the name of the new user that you want to delete.

Examples

  1. To delete user Joe, run users delete Joe

Editing an existing user

To Edit an existing user, use the user edit command.

Usage:

users edit <name> [--password=<password>] [--role=<prm>] [--email=<email>]

Options

Options and arguments Description
<name> Positional argument, replace <name> with the name of the user that needs to be edit.
--password=<password> Change the password, replace <password> with your chosen password.
--role=<prm> Edit the role of the user. Replace <prm> with either Read, ReadWrite, or Admin role.
--email=<email> Edit email address. Replace <email> with a new email address.

Examples

  1. To edit password of user Joe, run users create Joe --password slave4Life
  2. To edit the email and role of user Joe, run users create Joe --role Admin --email joe@protonmail.com
Last updated on 15 Nov 2022
Published on 30 Oct 2022