ssoauth
- Organization of this page
Format
- To add or change user information that is used for the SSO authentication method:
ssoauth -add -user user-name [-password password] [-auth {admin | operator}]- To delete user information that is used for the SSO authentication method:
ssoauth -delete -user user-name
- To output the command usage:
ssoauth -h
Function
The ssoauth command adds, changes, or deletes user information (the user name, password, and user authority) when you use SSO authentication for user authentication in the SSO console. User information is stored in the user authentication definition file (ssoauth.conf). For details about the user authentication definition file, see 6.3.26 User authentication definition file (ssoauth.conf).
If you execute the ssoauth command during execution of the following commands, the command terminates abnormally:
ssobackup, ssorestore, ssoauth
Options
-add
Adds or changes user information to be used for SSO authentication.
If you specify a user name that does not exist for the -user option, it is added. If you specify a user name that already exists, the existing user information is changed. That is, the password and user authority is overwritten.
If you omit the -password option, the user is a user without a password.
If you omit the -auth option, the user will have administrator permissions.
-delete
Deletes the user information to be used for SSO authentication. If you specify a user name that does not exist for the -user option, an error occurs.
-user user-name
Specifies a user name to be used for SSO authentication. The user name can have only ASCII characters and must be 1 byte to 32 bytes long.
Note that you cannot use a space, tab, quotation mark ("), asterisk (*), vertical bar (|), less-than sign (<), more-than sign (>), question mark (?), comma (,), equal sign (=), or hash mark (#).
-password password
Specifies the user password to be used for SSO authentication. The password can have only ASCII characters and must be 6 bytes to 32 bytes long.
Note that you cannot use a space, tab, quotation mark ("), asterisk (*), vertical bar (|), less-than sign (<), more-than sign (>), question mark (?), comma (,), equal sign (=), or hash mark (#).
-auth {admin|operator}
Specifies the user authority to be used for SSO authentication.
-
admin
Assigns administrator permissions.
-
operator
Assigns operator permissions.
For details on which functions can be used with each type of user authority, see 2.1.1(2) Menu frame.
-h
Outputs the command usage. This option cannot be specified together with other options.
Return values
|
0 |
Normal termination. |
|
-1 |
Execution error such as incorrect arguments |
|
-2 |
Execution error that occurred during editing of an SSO authentication user or backup and restore processing |