Users

The StorONE (S1) system may be accessed by multiple users. Using the S1 CLI client, you can list, create, edit, and delete users.

Create a new user

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

Usage:

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

Options

Options and arguments	Description
<name>	The name of the new user.
--password=<password>	The user password. Replace <password> with your chosen password.
--role=<permissions>	The user role. Replace <permissions> with either Read, ReadWrite, or Admin.
--email=<email>	The user email address. Replace <email> with an email address.

Passwords must include:
- Numbers and characters
- At least one upper-case character
- At least 8 characters

When logging in, the user may be required to provide a token sent to their email. For more information, see Two-factor authentication)

Examples

1. To create a user Joe with permissions to read and write, password free4Ever, and email joe@example.com, run:

   users create Joe --password free4Ever --role ReadWrite --email joe@example.com
   

2. To create a user Jane with permissions Admin, password have2Seat, and email jane@example.com, run:

   users create Jane --password have2Seat --role Admin --email jane@example.com
   

List all users

To list all users, run the users list command.

Usage:

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

Options

Options and arguments	Description
<name>	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 user Albert, run users list Albert.

Delete a user

To delete a user, log in as an 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

Edit an existing user

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

Usage:

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

Options

Options and arguments	Description
<name>	The name of the user to edit.
--password=<password>	Set a new password. Replace <password> with your chosen password.
--role=<permissions>	Set the role of the user. Replace <permissions> with either Read, ReadWrite, or Admin.
--email=<email>	Set the user email address. Replace <email> with the desired email address.

Examples

1. To change the password for user Joe to joey4Life, run:

   users edit Joe --password joey4Life
   

2. To change the email and role of user Joe, run:

   users edit Joe --role Admin --email joe@example.com