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

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: 

  • W = Writable
  • R = Readable
  • U = Updatable
  • M = Mandatory (Required)
  • DV = Default Value
PropertyWRUDescriptionMDVData TypeExample
JSONUI

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.YesN/AStringkim
credential         
Password The password for the user login, which should be at least six characters long.YesN/AStringkim12345
role          
User Role The role of the user. The following are the possible user roles that can be added:
  • admin
  • internal/user 
YesN/AStringinternal/user
emailEmail The email address of the user.YesN/AStringfoo@bar.com
firstName
First name The first name of the user.YesN/AStringFrank
lastName  
Last name The last name of the user.YesN/AStringMyers
profileName
- The user's profile. The default profile is always used in WSO2 Private PaaS.NoN/AString 
  • No labels