This documentation is for WSO2 Private PaaS 4.1.0. View documentation for the latest release.
Updating a User - WSO2 Private PaaS 4.1.0 - WSO2 Documentation
Skip to end of metadata
Go to start of metadata

You can update a user using the CLI tool or REST API as shown below:

The user's username can not be changed in the updating process.

Updating a user via the CLI

CLI command
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 definition
Short optionLong optionDescriptionRequiredExample value


Username given to the user.Yeskim


User's password.Yesadmin123

Role assigned to the user.



User's first name.YesKim


User's last name.YesMyers


User's email address.Yes[email protected]
-pr--profile-nameUser's profile name.Yesdev

Update the user with the username: kim.

User updated successfully: kim
Sample output
User added successfully: [user] kim

Updating a user via the REST API

DescriptionUpdate a specific user.
Resource Path/users
Request/Response Formatapplication/json
Command format
curl -X PUT -H "Content-Type: application/json" -d @'<JSON_PAYLOAD>' -k -v -u <USERNAME>:<PASSWORD> https://<PRIVATE_PAAS_HOST>:<PRIVATE_PAAS_HTTPS_PORT>/api/users
  • The path to the JSON file that defines the user needs to be defined as the <JSON_PAYLOAD> value.
  • By default, <USERNAME>:<PASSWORD> is admin:admin.
  • By default, <PRIVATE_PAAS_HOST> is localhost. However, if you are using a public IP, the respective IP address or domain needs to be specified.
  • By default, <PRIVATE_PAAS_HTTPS_PORT> has been set to 9443. However, if the port offset has been incremented by n, the default port value needs to be incremented by n.

Add the user defined in the user.json file. 

curl -X PUT -H "Content-Type: application/json" -d @'user.json' -k -v -u admin:admin https://localhost:9443/api/users
Sample output
> PUT /api/users HTTP/1.1
> Host: localhost:9443
> Authorization: Basic YWRtaW46YWRtaW4=
> User-Agent: curl/7.43.0
> Accept: */*
> Content-Type: application/json
> Content-Length: 136
< HTTP/1.1 200 OK
< Date: Wed, 14 Oct 2015 04:51:47 GMT
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
{"status":"success","message":"User updated successfully: [user] kim"

You will come across the following HTTP status codes while adding a user:

HTTP status code

201, 404, 500

See the descriptions of the HTTP status codes here.


Sample user JSON

  "userName": "kim",
  "credential": "kim12345",
  "role": "admin",
  "firstName": "Frank",
  "lastName": "Myers",
  "email": "[email protected]"


  • No labels