Default language.

tw_upduser


The tw_upduser utility enables you to update properties of a specific user, such as the current state, permissions, and passwords. To use the utility, type the following command at the $TIDEWAY/bin/ directory:

tw_upduser [options] username

where:

  • username is the name of the user to update
  • options are any of the options described in the following table and the common command line options described in Using-command-line-utilities.

Command Line Option

Description

--active

Sets the user to an ACTIVE state

--blocked

Sets the user to a BLOCKED state

--disabled

Sets the user to a DISABLED state

-f, --fullname=ARG

Sets a full name of the user

-G, --groups=GROUP ,...

Sets the user's group membership

--locked

Sets the user to a LOCKED state

--passwd-must-change

Specifies that the password must be changed

--passwd-ok

Specifies that the password is okay as currently stated

--passwd-should-change

Specifies that the password should be changed

--token

Print an API token to stdout that you use in the client you want to access the API.

For API users (api-access group) the token does not expire. For normal users (with a password) the token is valid for 3600 seconds.

User example

In the following example, the tw_upduser utility sets the user Joe to a locked state to protect from unauthorized changes to that account.

Locking a user for security purposes

To lock a user, type the following command:

$TIDEWAY/bin/tw_upduser --locked Joe

The following confirmation is displayed:

Set User State USER_STATE_LOCKED

To unlock the user, run the utility again with the --active option.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*