mirror of
https://github.com/Security-Onion-Solutions/securityonion.git
synced 2025-12-06 17:22:49 +01:00
fix formatting in so-user
This commit is contained in:
@@ -13,74 +13,74 @@ DEFAULT_ROLE=analyst
|
|||||||
|
|
||||||
function usage() {
|
function usage() {
|
||||||
cat <<USAGE_EOF
|
cat <<USAGE_EOF
|
||||||
Usage: $0 <operation> [supporting parameters]"
|
Usage: $0 <operation> [supporting parameters]
|
||||||
|
|
||||||
where <operation> is one of the following:"
|
where <operation> is one of the following:
|
||||||
|
|
||||||
list: Lists all user email addresses currently defined in the identity system"
|
list: Lists all user email addresses currently defined in the identity system
|
||||||
|
|
||||||
add: Adds a new user to the identity system"
|
add: Adds a new user to the identity system
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--role <role> (defaults to $DEFAULT_ROLE)"
|
--role <role> (defaults to $DEFAULT_ROLE)
|
||||||
--firstName <firstName> (defaults to blank)"
|
--firstName <firstName> (defaults to blank)
|
||||||
--lastName <lastName> (defaults to blank)"
|
--lastName <lastName> (defaults to blank)
|
||||||
--note <note> (defaults to blank)"
|
--note <note> (defaults to blank)
|
||||||
--skip-sync (defers the Elastic sync until the next scheduled time)
|
--skip-sync (defers the Elastic sync until the next scheduled time)
|
||||||
|
|
||||||
addrole: Grants a role to an existing user"
|
addrole: Grants a role to an existing user
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
--role <role>"
|
--role <role>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--skip-sync (defers the Elastic sync until the next scheduled time)
|
--skip-sync (defers the Elastic sync until the next scheduled time)
|
||||||
|
|
||||||
delrole: Removes a role from an existing user"
|
delrole: Removes a role from an existing user
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
--role <role>"
|
--role <role>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--skip-sync (defers the Elastic sync until the next scheduled time)
|
--skip-sync (defers the Elastic sync until the next scheduled time)
|
||||||
|
|
||||||
password: Updates a user's password and disables MFA"
|
password: Updates a user's password and disables MFA
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--skip-sync (defers the Elastic sync until the next scheduled time)
|
--skip-sync (defers the Elastic sync until the next scheduled time)
|
||||||
|
|
||||||
profile: Updates a user's profile information"
|
profile: Updates a user's profile information
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--role <role> (defaults to $DEFAULT_ROLE)"
|
--role <role> (defaults to $DEFAULT_ROLE)
|
||||||
--firstName <firstName> (defaults to blank)"
|
--firstName <firstName> (defaults to blank)
|
||||||
--lastName <lastName> (defaults to blank)"
|
--lastName <lastName> (defaults to blank)
|
||||||
--note <note> (defaults to blank)"
|
--note <note> (defaults to blank)
|
||||||
|
|
||||||
enable: Enables a user"
|
enable: Enables a user
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--skip-sync (defers the Elastic sync until the next scheduled time)
|
--skip-sync (defers the Elastic sync until the next scheduled time)
|
||||||
|
|
||||||
disable: Disables a user"
|
disable: Disables a user
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
Optional parameters: "
|
Optional parameters:
|
||||||
--skip-sync (defers the Elastic sync until the next scheduled time)
|
--skip-sync (defers the Elastic sync until the next scheduled time)
|
||||||
|
|
||||||
validate: Validates that the given email address and password are acceptable"
|
validate: Validates that the given email address and password are acceptable
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
|
|
||||||
valemail: Validates that the given email address is acceptable; requires 'email' parameter"
|
valemail: Validates that the given email address is acceptable; requires 'email' parameter
|
||||||
Required parameters: "
|
Required parameters:
|
||||||
--email <email>"
|
--email <email>
|
||||||
|
|
||||||
valpass: Validates that a password is acceptable"
|
valpass: Validates that a password is acceptable
|
||||||
|
|
||||||
Note that the password can be piped into STDIN to avoid prompting for it"
|
Note that the password can be piped into STDIN to avoid prompting for it
|
||||||
USAGE_EOF
|
USAGE_EOF
|
||||||
exit 1
|
exit 1
|
||||||
}
|
}
|
||||||
|
|||||||
Reference in New Issue
Block a user