ZxAuth CLI Commands
zxsuite auth credential add
zxsuite auth credential add *john@example.com* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
john@example.com |
|
password(O) |
String |
myPassword |
|
label(O) |
String |
myLabel |
|
qrcode(O) |
Boolean |
true|false |
false |
service(O) |
String[,..] |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth credential add john@example.com password myPassword label myLabel qrcode false service eas,mobileApp
zxsuite auth credential delete
zxsuite auth credential delete *john@example.com* *f51as*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
john@example.com |
|
password_id(M) |
String |
f51as |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth delete john@example.com f51as
zxsuite auth credential list
zxsuite auth credential list *john@example.com*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
john@example.com |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth list john@example.com
zxsuite auth credential update
zxsuite auth credential update *john@example.com* *f51as* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
john@example.com |
|
password_id(M) |
String |
f51as |
|
label(O) |
String |
myLabel |
|
enabled(O) |
Boolean |
true|false |
|
service(O) |
String[,..] |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth update john@example.com f51as label myLabel enabled false service WebUI
zxsuite auth doDeployAuthZimlet
zxsuite auth doDeployAuthZimlet
Usage Example
zxsuite auth doDeployAuthZimlet
zxsuite auth doRestartService
zxsuite auth doRestartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth doRestartService
zxsuite auth doStartService
zxsuite auth doStartService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth doStartService
zxsuite auth doStopService
zxsuite auth doStopService *service_name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
serv ice_name(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth doStopService
zxsuite auth enforce2FA get account
zxsuite auth enforce2FA get account
*8916a2c1-5ae6-4ed2-be53-4fded8071428*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
8916a2 c1-5ae6-4ed2-be 53-4fded8071428 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth enforce2FA get account
zxsuite auth enforce2FA get cos
zxsuite auth enforce2FA get cos
*8916a2c1-5ae6-4ed2-be53-4fded8071428*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
String |
8916a2 c1-5ae6-4ed2-be 53-4fded8071428 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth enforce2FA get cos
zxsuite auth enforce2FA set account
zxsuite auth enforce2FA set account
*8916a2c1-5ae6-4ed2-be53-4fded8071428* *0 (no_2fa) \| 1 (ip_2fa) \| 2
(device_2fa)*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
8916a2 c1-5ae6-4ed2-be 53-4fded8071428 |
|
value(M) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth enforce2FA set account john.doe@example.com 2
This command enables 2FA on a device for account john.doe@example.com. In case of a multiserver setup, the command can be issued on any server: If the account is not defined on the host on which the command is issued, it will be looked up on the other servers.
zxsuite auth enforce2FA set cos
zxsuite auth enforce2FA set cos
*8916a2c1-5ae6-4ed2-be53-4fded8071428* *0 (no_2fa) \| 1 (ip_2fa) \| 2
(device_2fa)*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
cos(M) |
String |
8916a2 c1-5ae6-4ed2-be 53-4fded8071428 |
|
value(M) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth enforce2FA set cos
zxsuite auth getServices
zxsuite auth getServices
Usage Example
zxsuite auth getServices
zxsuite auth loginPage getBackgroundImage domain
zxsuite auth loginPage getBackgroundImage domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage getBackgroundImage domain example.com
zxsuite auth loginPage getBackgroundImage global
zxsuite auth loginPage getBackgroundImage global
Usage Example
zxsuite auth loginPage getBackgroundImage global
zxsuite auth loginPage getColorPalette domain
zxsuite auth loginPage getColorPalette domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth loginPage getColorPalette domain
zxsuite auth loginPage getColorPalette global
zxsuite auth loginPage getColorPalette global
zxsuite auth loginPage getColorPalette global
zxsuite auth loginPage getConfig domain
zxsuite auth loginPage getConfig domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth loginPage getConfigdomain example.com
zxsuite auth loginPage getConfig global
zxsuite auth loginPage getConfig global
zxsuite auth loginPage getConfigglobal
zxsuite auth loginPage getFavicon domain
zxsuite auth loginPage getFavicon domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage getFavicon domain example.com
zxsuite auth loginPage getFavicon global
zxsuite auth loginPage getFavicon global
Usage Example
zxsuite auth loginPage getFavicon global
zxsuite auth loginPage getLogo domain
zxsuite auth loginPage getLogo domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth loginPage getLogo domain example.com
zxsuite auth loginPage getLogo global
zxsuite auth loginPage getLogo global
zxsuite auth loginPage getLogo global
zxsuite auth loginPage getSkinLogoAppBanner domain
zxsuite auth loginPage getSkinLogoAppBanner domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage getSkinLogoAppBanner domain example.com
zxsuite auth loginPage getSkinLogoAppBanner global
zxsuite auth loginPage getSkinLogoAppBanner global
Usage Example
zxsuite auth loginPage getSkinLogoAppBanner global
zxsuite auth loginPage getSkinLogoURL domain
zxsuite auth loginPage getSkinLogoURL domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage getSkinLogoURL domain example.com
zxsuite auth loginPage getSkinLogoURL global
zxsuite auth loginPage getSkinLogoURL global
Usage Example
zxsuite auth loginPage getSkinLogoURL global
zxsuite auth loginPage getTitle domain
zxsuite auth loginPage getTitle domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage getTitle domain example.com
zxsuite auth loginPage getTitle global
zxsuite auth loginPage getTitle global
Usage Example
zxsuite auth loginPage getTitle global
zxsuite auth loginPage setBackgroundImage domain
zxsuite auth loginPage setBackgroundImage domain *domain*
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
path(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setBackgroundImage domain example.com http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setBackgroundImage global
zxsuite auth loginPage setBackgroundImage global
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
path(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setBackgroundImage global http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setColorPalette domain
zxsuite auth loginPage setColorPalette domain *domain* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
primary(O) |
String |
hexadecimal color |
|
secondary(O) |
String |
hexadecimal color |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth loginPage setColorPalette domain example.com primary 6174AE
zxsuite auth loginPage setColorPalette global
zxsuite auth loginPage setColorPalette global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
primary(O) |
String |
hexadecimal color |
|
secondary(O) |
String |
hexadecimal color |
(M) == mandatory parameter, (O) == optional parameter
zxsuite auth loginPage setColorPalette global primary 6174AE
zxsuite auth loginPage setFavicon domain
zxsuite auth loginPage setFavicon domain *domain*
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
path(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setFavicon domain example.com http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setFavicon global
zxsuite auth loginPage setFavicon global
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
path(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setFavicon global
zxsuite auth loginPage setLogo domain
zxsuite auth loginPage setLogo domain *domain*
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
path(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setLogo domain example.com http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setLogo global
zxsuite auth loginPage setLogo global
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
path(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setLogo global http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setSkinLogoAppBanner domain
zxsuite auth loginPage setSkinLogoAppBanner domain *domain*
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
skin_logo_ap p_banner(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setSkinLogoAppBanner domain example.com http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setSkinLogoAppBanner global
zxsuite auth loginPage setSkinLogoAppBanner global
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
skin_logo_ap p_banner(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setSkinLogoAppBanner global http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setSkinLogoURL domain
zxsuite auth loginPage setSkinLogoURL domain *domain*
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
skin_ logo_url(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setSkinLogoURL domain example.com http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setSkinLogoURL global
zxsuite auth loginPage setSkinLogoURL global
http://wwww.example.com/images/myimage.jpg
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
skin_ logo_url(M) |
String |
http://wwww. example.com/ima ges/myimage.jpg |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setSkinLogoURL global http://wwww.example.com/images/myimage.jpg
zxsuite auth loginPage setTitle domain
zxsuite auth loginPage setTitle domain *domain* *'My Custom Login
Page'*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
title(M) |
String |
‘My Custom Login Page’ |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setTitle domain example.com 'My Custom Login Page'
zxsuite auth loginPage setTitle global
zxsuite auth loginPage setTitle global *'My Custom Login Page'*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
title(M) |
String |
‘My Custom Login Page’ |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth loginPage setTitle global 'My Custom Login Page'
zxsuite auth policy list domain
zxsuite auth policy list domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
service(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy list domain example.com
zxsuite auth policy list global
zxsuite auth policy list global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
service(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy list global
zxsuite auth policy set Cli domain
zxsuite auth policy set Cli domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Cli domain example.com ip_can_change true
zxsuite auth policy set Cli global
zxsuite auth policy set Cli global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Cli global ip_can_change true
zxsuite auth policy set Dav domain
zxsuite auth policy set Dav domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Dav domain example.com ip_can_change true
zxsuite auth policy set Dav global
zxsuite auth policy set Dav global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Dav global ip_can_change true
zxsuite auth policy set EAS domain
zxsuite auth policy set EAS domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set EAS domain example.com ip_can_change true
zxsuite auth policy set EAS global
zxsuite auth policy set EAS global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set EAS global ip_can_change true
zxsuite auth policy set Imap domain
zxsuite auth policy set Imap domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Imap domain example.com ip_can_change true
zxsuite auth policy set Imap global
zxsuite auth policy set Imap global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Imap global ip_can_change true
zxsuite auth policy set MobileApp domain
zxsuite auth policy set MobileApp domain *domain* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set MobileApp domain example.com ip_can_change true
zxsuite auth policy set MobileApp global
zxsuite auth policy set MobileApp global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set MobileApp global ip_can_change true
zxsuite auth policy set Pop3 domain
zxsuite auth policy set Pop3 domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Pop3 domain example.com ip_can_change true
zxsuite auth policy set Pop3 global
zxsuite auth policy set Pop3 global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Pop3 global ip_can_change true
zxsuite auth policy set Smtp domain
zxsuite auth policy set Smtp domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Smtp domain example.com ip_can_change true
zxsuite auth policy set Smtp global
zxsuite auth policy set Smtp global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set Smtp global ip_can_change true
zxsuite auth policy set WebAdminUI domain
zxsuite auth policy set WebAdminUI domain *domain* [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set WebAdminUI domain example.com ip_can_change true
zxsuite auth policy set WebAdminUI global
zxsuite auth policy set WebAdminUI global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set WebAdminUI global ip_can_change true
zxsuite auth policy set WebUI domain
zxsuite auth policy set WebUI domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set WebUI domain example.com ip_can_change true
zxsuite auth policy set WebUI global
zxsuite auth policy set WebUI global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set WebUI global ip_can_change true
zxsuite auth policy set ZmWebUI domain
zxsuite auth policy set ZmWebUI domain *domain* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set ZmWebUI domain example.com ip_can_change true
zxsuite auth policy set ZmWebUI global
zxsuite auth policy set ZmWebUI global [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
i p_can_change(O) |
Boolean |
true|false |
|
trus ted_ip_range(O) |
String[,..] |
192.168 .0.1/16,192.168 .100.14/24[,…] |
|
2fa_policy(O) |
Integer |
0 (no_2fa) | 1 (ip_2fa) | 2 (device_2fa) |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy set ZmWebUI global ip_can_change true
zxsuite auth policy trustedDevice getExpiration domain
zxsuite auth policy trustedDevice getExpiration domain *domain*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy trustedDevice getExpiration domain example.com
zxsuite auth policy trustedDevice getExpiration global
zxsuite auth policy trustedDevice getExpiration global
Usage Example
zxsuite auth policy trustedDevice getExpiration global example.com 20
zxsuite auth policy trustedDevice setExpiration domain
zxsuite auth policy trustedDevice setExpiration domain *domain*
*value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
||
value(M) |
Long |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy trustedDevice setExpiration domain example.com 20
zxsuite auth policy trustedDevice setExpiration global
zxsuite auth policy trustedDevice setExpiration global *value*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
value(M) |
Long |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth policy trustedDevice setExpiration global 20
zxsuite auth saml delete
zxsuite auth saml delete *example.com* *organization.name*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
example.com |
|
key(M) |
String |
or ganization.name |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth saml delete
zxsuite auth saml get
zxsuite auth saml get *example.com* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
example.com |
|
key(O) |
String |
or ganization.name |
|
export_to(O) |
Path |
./s aml-config.json |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth saml get
zxsuite auth saml import
zxsuite auth saml import *example.com* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
example.com |
|
file(O) |
Path |
./s aml-config.json |
|
url(O) |
String |
http://d omain/sso/saml/ |
|
al low_unsecure(O) |
Boolean |
true|false |
false |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth saml import
zxsuite auth saml update
zxsuite auth saml update *example.com* *organization.name* *Zextras*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
domain(M) |
String |
example.com |
|
key(M) |
String |
or ganization.name |
|
value(M) |
String |
Zextras |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth saml update
zxsuite auth saml validate
zxsuite auth saml validate *./saml-config.json*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
file(M) |
Path |
./s aml-config.json |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth saml validate
zxsuite auth token invalidate
zxsuite auth token invalidate *user@example.com|uuid* *uuid|all*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
user@example.com | uuid |
|
token_id(M) |
String |
uuid | all |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth token invalidate user@example.com 49561162-d3fa-452f-aef0-d5fd2875695d
zxsuite auth token list
zxsuite auth token list *uuid\|\ *\ user1@example.com [param
VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account(M) |
String |
user@example.com | uuid |
|
c redential_id(O) |
String |
||
cred ential_label(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth token list {account} credential_id j18ai credential_label myCredential
zxsuite auth totp delete
zxsuite auth totp delete *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account (M) |
String |
||
id(O) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth totp delete {account} <id>
zxsuite auth totp generate
zxsuite auth totp generate *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account (M) |
String |
||
algorithm(O) |
String |
SHA 1|SHA256|SHA512 |
SHA1 |
pin(O) |
String |
||
s ecret_length(O) |
Integer |
32 |
32 |
period(O) |
Integer |
30|60 |
30 |
d igits_length(O) |
Integer |
6|8|10 |
6 |
hu man_readable(O) |
Boolean |
true|false |
true |
pin_prepend(O) |
Boolean |
true|false |
false |
static_code(O) |
Integer |
0|…|12| |
12 |
label_prefix(O) |
String |
alphanumeric string (with dashes and underscores allowed) of length up to 20 characters |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth totp generate generate {account} <algorithm> <pin> <secret_length> <period> <digits_length> <human_readable> <pin_prepend> <static_code>
zxsuite auth totp list
zxsuite auth totp list *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account (M) |
String |
||
id(O) |
Long |
42 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth totp list {account} <id>
zxsuite auth trustedDevice delete
zxsuite auth trustedDevice delete *account* [param VALUE[,VALUE]]
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account (M) |
String |
||
deviceId(O) |
String |
device-id |
|
ip(O) |
String |
192.168.42.42 |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth trustedDevice delete
zxsuite auth trustedDevice list
zxsuite auth trustedDevice list *account*
Parameter List
NAME |
TYPE |
EXPECTED VALUES |
DEFAULT |
account (M) |
String |
(M) == mandatory parameter, (O) == optional parameter
Usage Example
zxsuite auth trustedDevice list