config userlist

  • Published on Mar 5, 2025
  • 1 minute(s) read
  • jM
 Prev Next

Commands for inspecting and changing the users allowed to access the system’s web API.

show userlist

Print the list of web users.

show userlist

Example output:

[Fri Jan 24 06:48:59 2025] > show userlist
[Fri Jan 24 06:49:00 2025] Showing User List
[Fri Jan 24 06:49:00 2025]
[Fri Jan 24 06:49:00 2025] UserList Enable: true
[Fri Jan 24 06:49:00 2025]
[Fri Jan 24 06:49:00 2025] --------------------------------------------------
[Fri Jan 24 06:49:00 2025]
[Fri Jan 24 06:49:00 2025]   UserName   : fmadio
[Fri Jan 24 06:49:00 2025]   Permission : full
[Fri Jan 24 06:49:00 2025]   SecBPF     :
[Fri Jan 24 06:49:00 2025]
[Fri Jan 24 06:49:00 2025]   UserName   : oidamf
[Fri Jan 24 06:49:00 2025]   Permission : user
[Fri Jan 24 06:49:00 2025]   SecBPF     :
[Fri Jan 24 06:49:00 2025]
[Fri Jan 24 06:49:00 2025] --------------------------------------------------

config userlist add

Add a new web user with a given name.

config userlist add <user name>

Example output:

[Fri Jan 24 06:47:44 2025] > config userlist add oidamf
[Fri Jan 24 06:48:39 2025] Created new User [oidamf]

config userlist del

Delete a web user by name.

Note that the default user, named fmadio, can never be deleted.

config userlist del <user name>

Example output:

[Fri Jan 24 07:54:53 2025] > config userlist del oidamf
[Fri Jan 24 07:54:54 2025] deleted username [oidamf]

config userlist password

Change the password for one web user.

config userlist password <user name>

Example output:

[Fri Jan 24 07:54:05 2025] > config userlist password oidamf
[Fri Jan 24 07:54:06 2025] New Password     : *************
[Fri Jan 24 07:54:11 2025] Re-enter Password: *************
[Fri Jan 24 07:54:15 2025] web password for username [oidamf] set

config userlist permission

Dictate whether a web user has access to all API endpoints, or only a restricted subset.

Also see `config security default_role`.

config userlist permission <user name> <full|user>

Example output:

[Fri Jan 24 07:54:33 2025] > config userlist permission oidamf full
[Fri Jan 24 07:54:36 2025] modified username [oidamf] to permission level [full]
[Fri Jan 24 07:54:38 2025] > config userlist permission oidamf user
[Fri Jan 24 07:54:38 2025] modified username [oidamf] to permission level [user]