S-Filer Admin CLI : User Guide
Note
The S-Filer Admin CLI is a command-line utility that allows administrators to manage S-Filer Portal users, groups and communities.
Concepts
The application requires authentication to access its functions. Once authenticated, users can perform operations such as managing users, groups and communities.
It runs on Windows and Linux operating systems. Simply open a command console and execute the necessary commands. You can use the --help parameter to get help on the commands available.
Each command is made up of several options, some of which are used by all commands. Common options are :
| Options | Required/Optional | Description |
|---|---|---|
| -l | Required | username to use to perform the action |
| -ld | Optional | Domain ID to login to. Use the list-domains command to get the IDs of the domains. Default: 1 |
| -log | Optional | The name of the log file. If none is specified, there are no log file. If verbose, debug logs are written. |
| -op | Optional | The obfuscated (hidden) password to authenticate |
| -p | Required | The password to authenticate |
| -s | Required | The URL of the server to use. (Ex: [https://[PUBLIC](https://[PUBLIC ADDRESS]/sfiler/server. |
After the required properties, you need to add the command and the parameters specific to that command.
Commands
The S-Filer Admin CLI supports the following commands:
- add-auth-factor-access-token
- add-community
- add-group
- add-user
- assign-group-to-community
- assign-user-to-community
- assign-user-to-group
- change-password
- delete-auth-factor-access-token
- delete-auth-factor-totp
- delete-community
- delete-group
- delete-user
- get-theme-for-user
- hide-password
- list-admins
- list-auth-factor-access-token
- list-communities
- list-domains
- list-groups
- list-groups-in-community
- list-users
- list-users-in-community
- list-users-in-group
- modify-community
- modify-group
- modify-user
- transfer-ownership
- unassign-group-from-community
- unassign-user-from-community
- unassign-user-from-group