update_user

Edit online

Update information for a Guardium user.

To make changes to roles for this user, use the set_user_roles API.

This API is available in Guardium V9.5 and later.

REST API syntax

This API is available as a REST service with the PUT method. Call this API as follows: 
PUT https://[Guardium hostname or IP address]:8443/restAPI/user

GuardAPI syntax

update_user parameter=value

Parameters

Parameter Value type Description
confirmPassword String Required. Confirm the password. The confirmPassword must match the value of Password.
country String The ISO 3166 2-letter country code for this user, such as US or ES. For valid values, call update_user from the command line with --help=true.
disabled Boolean Enables or disables this user. Valid values:
  • 0 (false): The user is enabled.
  • 1 (true): The user is disabled.
Default = 0
disablePwdExpiry Boolean Valid values:
  • 0 (false)
  • 1 (true)

Default = 1 (true)
email String The user's email address
firstName String The user's given name.
lastName String The user's family name.
password String Required. The password must be at least 8 characters long and include at least one of each:
  • An uppercase letter (A-Z)
  • A lowercase letter (a-z)
  • A number (0-9)
  • A special character, which can be: at sign (@), hashtag (#), dollar sign ($), percent sign (%), caret (^), ampersand (&), asterisk (*), exclamation (!), hyphen (-), underscore (_), plus (+), or equals (=).
smartCardUserName String Common name in the certificate. Enter the smart card user name when smart card authentication is turned on.
userName String Required. A user name for this user.

The following characters are not allowed in user names: semicolon (;), forward slash (/), dollar sign ($), and percent sign (%).

Examples

After using the create_user API to create a new user named Fred McDerf, you realize that you forgot to add his email address. Use update_user to add the email address as follows:

grdapi update_user userName="Fred McDerf" email=fredmcd@company.com