CLI command user

---

User management with the CLI command user

Last adaptation to the version: 12.6.0

New:

• Correction syntax user attribute otpsecret

Last updated: 

09.2023

notempty

This article refers to a Resellerpreview

v12.5.1 v11

Access: UTM-IP:Port or UTM-URL:Port
Port as configured at Network / Appliance Settings / Webserver
Default-Port: 11115
i.e.: https://utm.ttt-point.de:11115
Default: https://192.168.175.1:11115 → Extras →CLI

---

If no values are to be passed for a parameter, this parameter is not to be specified. If a parameter value is to be overwritten with <empty>, two square brackets must be used.
Example: user set id "10" groups [ ] (Note the spaces between the brackets!)

If multiple values are to be passed in one parameter, they must be enclosed in inverted commas and surrounded by square brackets with a space between them.
Example: user set id "10" groups [ "Group1" "Group2" "Group3" ]

Command	Parameter	Description	Example
user user get user get		Displays all or individual users Value Description name Name of the user account id ID of the user account groups Group of the user account permission User account permissions	Show all users: user get
	name	Optional. Name of the user account	Show user "user1" user get name "benutzer1"
user new user new		Creates a new user	user new name "benutzer2" password "insecure" groups "ssl-user"
	name	Name of the user account
	password	Password of the user account
	groups	Group of the user account
user set user set		Changes user settings	user set id "183" groups vpn-user
	id	ID of the user account
	name	Optional. Name of the user account
	groups	Group of the user account
user delete user delete		Deletes a user. One parameter sufficient.	user delete id "193"
	id	ID of the user account
	name	Name of the user account
user check user check		Checks whether a user is a member of a specific group	user check name "benutzer1" groups "vpn-user"
	name	Name of the user account
	groups	Group of the user account
user checkotp user checkotp		Verify the OTP code from the token	user checkotp name "user1" code "1234562"
	name	Name of the user account
	code	OTP code to be checked for validity
user who user who	–	Shows which user is connected and logged in	user who
user attribute user attribute get user attribute get		Displays the attributes of one or all users Value Description name Name of the user account attribute Displays the attributes of one or all users value Attribute value	user attribute get
	name	Optional. Name of the user account	user attribute get name "benutzer1"
user attribute set user attribute set		Ändert die Attribute des Benutzers	user attribute set name "admin" attribute "password_change" value "1"
	user	Name of the user account
	attribute	Displays the attributes of one or all users mailfilter_download_attachments_filtered mailfilter_email_addresses openvpn_certificate openvpn_client_download openvpn_gateway openvpn_name openvpn_redirectgateway password_change password_chars_case password_chars_numbers password_chars_special password_length vpn_l2tp_ip vpn_openvpn_ip vpn_pptp_ip wake_on_lan_hosts
	value	Attribute value
user attribute otpsecret user attribute otpsecret		Generates a new OTP shared secret code	user attribute otpsecret name "user1" spcli user attribute otpsecret name "user1"
	user	Name of the user account
user captiveportal user captiveportal get user captiveportal get	–	Listing of all Captive Portal user accounts	user captiveportal get
user captiveportal new user captiveportal new		Creates a Captive Portal user account	user captiveportal new name "CP-User" password "InSecure" expirydate "24:00"
	name	Captive Portal user account name
	password	Captive Portal user account password
	expirydate	Expiration date
user captiveportal set user captiveportal set		Changing the password or expiration date of the Captive Portal user account.	Change password: user captiveportal set name "CP-User" password "CP-InSecure" Change expiration date: user captiveportal set name "CP-User" expirydate "12:00"
	name	Captive Portal user account name
	password	Captive Portal user account password
	expirydate	Expiration date
user captiveportal delete user captiveportal delete		Deletes a Captive Portal user account	user captiveportal delete name "CP-User"
	name	Captive Portal user account name
user group user group get user group get	–	Displays the groups Value Description id ID of the group name Name of the group directory_name Name of the directory service of the group permission Group authorization ibf_flags IBF Limitations of the group	user group get
user group new user group new		Creates a new group	user group new name "proxy-user" permission "HTTP_PROXY"
	name	Name of the group
	permission	Group authorization MAILDIGESTS ADMIN VPN_PPTP VPN_L2TP MAILFILTER_ADMIN HTTP_PROXY WEB_USER VPN_OPENVPN MAIL_RELAY IPSEC_XAUTH VPN_CLIENTLESS
user group set user group set		Changes the settings of a group	user group set id "194" permission [ WEB_USER VPN_CLIENTLESS ]
	id	ID of the group
	name	Optional. Name of the group
	permission	Group authorization MAILDIGESTS ADMIN VPN_PPTP VPN_L2TP MAILFILTER_ADMIN HTTP_PROXY WEB_USER VPN_OPENVPN MAIL_RELAY IPSEC_XAUTH VPN_CLIENTLESS
user group delete user group delete		Deletes a group. One parameter sufficient.	user group delete id "194"
	id	ID of the group
	name	Name of the group
user group attribute get user group attribute get		Shows the attributes of the groups Value Description name Name of the group attribute Attributes assigned to the group value Attribute value	user group attribute get
user group attribute set user group attribute set		Adds attributes to a group	user group attribute set name "Userinterface" attribute "openvpn_client_download" value "0"
	name	Name of the group
	attribute	Attributes assigned to the group
	value	Attribute value
user group attribute delete user group attribute delete		Deletes an attribute of a group	user group attribute delete name "Userinterface" attribute "openvpn_client_download"
	name	Name of the group
	attribute	Attributes assigned to the group mailfilter_download_attachments_filtered mailfilter_email_addresses openvpn_certificate openvpn_gateway openvpn_name openvpn_redirectgateway wake_on_lan_hosts
user support new user support new		Creates a support user	user support new name "Support" password "InSecure" groups "User" expirydate "24:00"
	name	Name of the user account
	password	Password of the user account
	groups	Group of the user account
	expirydate	Expiration date
	flags	Optional. User account restrictions