Overview

CLI command
update-user
DescriptionUpdate a specific user.
Command format
update-user -u <USERNAME> -p <PASSWORD> -r <ROLE_NAME> -f <FIRST_NAME> -l <LAST_NAME> -e <EMAIL> -pr <PROFILE_NAME>

Parameter definitions

Short optionLong optionDescriptionRequiredExample value
-u

--username

Username given to the user.Yesadmin2
-p

--password

User's password.Yesadmin123
-r--role-nameRole assigned to the user.Yesadmin
-f

--first-name

User's first name.YesKim
-l

--last-name

User's last name.YesMyers
-e

--email

User's email address.Yesfoo@bar.com
-pr--profile-nameUser's profile name.Yesdev

Sample user JSON

{
  "userName": "kim",
  "credential": "kim12345",
  "role": "admin",
  "firstName": "Frank",
  "lastName": "Myers",
  "email": "foo@bar.com"
}

For information on the parameter definitions, see User Resource Definition.

Example

Use case:  Update the user with the username: frank5. 

update-user -u admin2 -p admin123 -r admin -f Kim -l Myers -e foo@bar.com -pr dev

Sample output

User updated successfully: admin2.
  • No labels