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

A tenant is a group of users (e.g., users that belong to an organization) who share a common access with specific privileges to the software instance. A sample tenant definition, together with information on all the properties that can be added in a tenant definition JSON are as follows:

Sample tenant definition JSON

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

{
  "admin": "admin",
  "firstName": "Frank",
  "lastName": "Myers",
  "adminPassword": "admin123",
  "tenantDomain": "frank.com",
  "email": "foo@bar.com",
  "active": "true"
} 

Property definitions

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

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

Main property definitions

Property

W

R

U

Description

M

DV

Data Type

Example

JSON

UI

admin

Admin user name

 

The tenant's username.

Yes

N/A

String

admin

firstName

First name

 

The tenant's first name.

Yes

N/A

String

Frank

lastName

Last name

 

The tenant's last name.

Yes

N/A

String

Myers

adminPassword

Admin user password

 

The tenant's default password that is specified by the super administrator.

Yes

N/A

String

admin123

tenantDomain

Tenant domain

X

The tenant's domain name. The domain name should be unique. If the given domain name is already registered, the tenant adding process will fail.

Yes

N/A

String

frank.com

email

Admin email

The tenant's email address.

Yes

N/A

String

foo@bar.com

active

Active

This determines whether or not to activate the tenant.

No

true

Boolean

true

tenantId

-

X

The tenant ID needs to be added only when updating a tenant. The tenant ID can be identified by listing the tenant details.

Yes

N/A

iInt

2

successKey

-

X

XThe success key that the server sends to indicate that the tenant is added successfully.NoN/A

String

 

createdDate

-

X

X

Date the tenant is created.

NoN/A

Long

 

originatedService

-

X

 The service that the tenant registration was originated.No 

String

 

usagePlan

-

X

 

The usage plan defines limitations (such as number of users, bandwidth, etc.) for the tenant. WSO2 Private PaaS comes with a predefined list, and you can add your item and/or tailor the existing items. For on-premises deployment, there is only one default plan, i.e., Demo. However, this property is not used in WSO2 Private PaaS.

No 

String

 
  • No labels