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

You can add a user using the CLI tool, REST API or the PPaaS Console as shown below:


Adding a user via the CLI

CLI commandadd-user
DescriptionAdd a new user.
Command format
Parameter definition
Short optionLong optionDescriptionRequiredExample value


Username given to the user.Yeskim


User's password.Yesadmin123

Role assigned to the user.

When adding a user in Stratos, only the following values are allowed for the property "role":

  • Internal/user
  • Admin


User's first name.YesKim


User's last name.YesMyers


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

Add a user with the username: kim, name: Kim Myers, password: admin123, email: [email protected], role: admin and profile: dev.

add-user -u kim -p admin123 -r admin -f Kim -l Myers -e [email protected] -pr dev
Sample output
User added successfully: [user] kim

Adding a user via the REST API

DescriptionAdd a user.
Resource Path/users
Request/Response Formatapplication/json
Command format
curl -X POST -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 POST -H "Content-Type: application/json" -d @'user.json' -k -v -u admin:admin https://localhost:9443/api/users
Sample output
> POST /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 201 Created
< Date: Tue, 13 Oct 2015 17:33:27 GMT
< Location: https://localhost:9443/api/users/kim
< Content-Type: application/json
< Transfer-Encoding: chunked
< Server: WSO2 Carbon Server
{"status":"success","message":"User added successfully: [user] kim"}

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

HTTP status code

201, 400, 409, 500

See the descriptions of the HTTP status codes here.

Location header URL


Adding a user via the PPaaS Console

Follow the instructions below to add a user:

Only users who belong to the admin user role are allowed to add users in PPaaS.

  1. Click Users on the home page.
  2. Click Manage Users.
  3. Click Add New Users
  4. Enter the required details. For property definitions, see User Resource Definition.
  5. Click SAVE USER.


Sample user JSON

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