User Resource Definition

A user is a person who interacts with the Private PaaS system. There can be many types of users in Private PaaS such as tenant administrators, DevOps, developers, end-user app developers and end-user. A sample user definition, together with information on all the properties that can be added in a user definition JSON are as follows:

Sample user definition JSON

The following are sample configurations that can be used in a JSON to define a user:

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

Property definitions

All the properties that correspond to the user resource are explained as follows:

userName
credential
role
firstName
lastName
email
profileName

W = Writable

R = Readable

U = Updatable

M = Mandatory (Required)

DV = Default Value

Property		W	R	U	Description	M	DV	Data Type	Example
JSON	UI	W	R	U	Description	M	DV	Data Type	Example
userName	User Name	√	√		Username of the user, which will be used when login. When updating user details, note that this property can not be updated.	Yes	N/A	String	kim
credential	Password	√	√		The password for the user login, which should be at least six characters long.	Yes	N/A	String	kim12345
role	User Role	√	√		The role of the user. The following are the possible user roles that can be added: admin internal/user	Yes	N/A	String	internal/user
`email`	Email	√	√		The email address of the user.	Yes	N/A	String	foo@bar.com
firstName	First name	√	√		The first name of the user.	Yes	N/A	String	Frank
lastName	Last name	√	√		The last name of the user.	Yes	N/A	String	Myers
profileName	-	√	√		The user's profile. The default profile is always used in WSO2 Private PaaS.	No	N/A	String