User Administration commands

The following INTool commands appear under the User Administration category.

add-users

Use the add-users command to add Windows users to Perceptive Content or to add Perceptive Content users from a file when you specify the optional file.

Note To use the add-users command, you must be a Perceptive Manager.

The following table contains arguments for the add-users command.

Argument	Description
`--file <file name>`	Optional. Specifies the name of the users file.
`--login-name <user name>`	Specifies your user name. Use this argument together with `--login-password` to authenticate your role as a Perceptive Manager.
`--login-password <password>`	Specifies your system password. Use this argument together with `--login-name` to authenticate your role as a Perceptive Manager.

When you specify a file, each line in the file contains one user, which you can format with or without the group to which the user belongs, using a <user name>\<group name> format.

When you do not specify a file, you are prompted for the user name or base name. After running the add-users command, for example, if you type test, 10, and 5 for the number of users to add; when prompted, the command creates users called test10, test11, test12, test13, and test14.

The add-userscommand does not add UNIX users.

intool --cmd add-users --login-name pman --login-password ImageNow --file HRusers.txt

intool --cmd add-users --login-name pman --login-password ImageNow

logoff

Use the logoff command to log off a user session.

The following table contains arguments for the logoff command.

Argument	Description
`--username <user name>`	Specifies the user to log off.

After running the logoff command, INTool prompts you to select the appropriate corresponding line number of the user session you want to log off.

Note Logging off a user session may cause loss of data if the user is in the middle of an operation.

intool --cmd logoff --username asmith

logoff-expired-sessions

Use the logoff-expired-sessions command to log off a user session that has persisted longer than the specified number of minutes. User sessions can be further filtered by client license type.

The following table contains arguments for the logoff-expired-sessions command.

Argument	Description
`--max-age <minutes>`	Specifies the maximum duration in minutes a user session can remain logged in to the system.
`--lictype <license type>`	Optional. Specifies the client license types associated with a user session that will be logged off of the system after the maximum duration is passed.

Note Logging off a user session may cause loss of data if the user is in the middle of an operation.

delete-users

Use the delete-users command to delete Perceptive Content or Windows users from the system.

The following table contains arguments for the delete-users command.

Argument	Description
`--login-name <user name>`	Specifies your user name. Use this argument together with `--login-password` to authenticate your role as a Perceptive Manager.
`--login-password <password>`	Specifies your system password. Use this argument together with `--login-name` to authenticate your role as a Perceptive Manager.

intool --cmd delete-users --login-name pman --login-password ImageNow

promote-perceptive-manager

Use the promote-perceptive-manager command to promote a user to Perceptive Manager.

Note To use the promote-perceptive-manager command, you must be a Perceptive Manager. If there is no match for the user name entered in the argument, the system alerts you and asks if you want to create a Perceptive Manager with the provided user name.

The following table contains arguments for the promote-perceptive-manager command.

Argument	Description
`--username <user name>`	Specifies the user to designate as a Perceptive Manager.
`--login-user <user name>`	Optional. Specifies your user name. Use this argument together with `--login-password` to authenticate your role as a Perceptive Manager.
`--login-password <password>`	Optional. Specifies your system password. Use this argument together with `--login-user` to authenticate your role as a Perceptive Manager.

intool --cmd promote-perceptive-manager --username sampleuser1

demote-perceptive-manager

Use the demote-perceptive-manager command to demote a user from the Perceptive Manager role.

Note To use the demote-perceptive-manager command, you must be a Perceptive Manager.

The following table contains arguments for the demote-perceptive-manager command.

Argument	Description
`--username <user name>`	Specifies the user to remove as a Perceptive Manager.
`--login-user <user name>`	Optional. Specifies your user name. Use this argument together with `--login-password` to authenticate your role as a Perceptive Manager.
`--login-password <password>`	Optional. Specifies your system password. Use this argument together with `--login-user` to authenticate your role as a Perceptive Manager.

intool --cmd demote-perceptive-manager --username sampleuser2

send-message

Use the send-message command to send a text message to a user or to all connected Perceptive Content users.

The following table contains arguments for the send-message command.

Argument	Description
`--recipient <user name>`	Specifies the name of a single user.
`--broadcast`	Sends the message to all connected Perceptive Content users.
`--message <message>`	Specifies the message to send. Quotation marks are required.

intool --cmd send-message --broadcast --message
“Log off at 5:00 PM for system maintenance.”

expire-digital-ids

Use the expire-digital-ids command to immediately expire all active digital IDs. Users are required to enter a new password the next time they apply a digital signature to a document in Perceptive Content.

intool --cmd expire-digital-ids

create-authentication-token

Use the create-authentication-token command to create an authentication token for the specified application.

Note Prior to running this command, you must set token signing configuration settings in inow.ini.

The following table contains arguments for the create-authentication-token command.

Argument	Description
`--lictype`	Specifies the application name. Supported application names are ImageNow Business Insight, ImageNow Forms Server, and Mail Agent.
`--file`	Optional. Specifies a file to which to write the authentication token.

intool --cmd create-authentication-token --lictype
Mail Agent

openidconnect-invalidate-discovery-configuration

Use the openidconnect-invalidate-discovery-configuration command to invalidate cached information associated with an OpenID Connect auto discovery profile.

Note This only affects OpenID Connect authentication profiles that are using auto.discovery.

The following table contains arguments for the openidconnect-invalidate-discovery-configuration command.

Argument	Description
`--profile`	Optional. Specifies the profile configured in inserver.ini to validate. If not specified, all cached OpenID Connect profile information is invalidated.

#Invalidates configuration for all profiles.

intool --cmd openidconnect-invalidate-discovery-configuration

#Invalidates configuration for a specific profile.

intool --cmd openidconnect-invalidate-discovery-configuration --profile default